mini-effect
    Preparing search index...

    Interface EnumSchema<TEnum, TMessage>

    Enum schema interface.

    interface EnumSchema<
        TEnum extends Enum,
        TMessage extends ErrorMessage<EnumIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<EnumValues<TEnum>, EnumIssue>;
        "~standard": StandardProps<EnumValues<TEnum>, EnumValues<TEnum>>;
        "~types"?: { input: EnumValues; issue: EnumIssue; output: EnumValues };
        async: false;
        enum: TEnum;
        expects: string;
        kind: "schema";
        message: TMessage;
        options: EnumValues<TEnum>[];
        reference: {
            <const TEnum extends Enum>(enum__: TEnum): EnumSchema<TEnum, undefined>;
            <
                const TEnum extends Enum,
                const TMessage extends ErrorMessage<EnumIssue> | undefined,
            >(
                enum__: TEnum,
                message: TMessage,
            ): EnumSchema<TEnum, TMessage>;
        };
        type: "enum";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~standard ~types? async enum expects kind message options reference type

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<EnumValues<TEnum>, EnumIssue>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<EnumValues<TEnum>, EnumValues<TEnum>>

    The Standard Schema properties.

    "~types"?: { input: EnumValues; issue: EnumIssue; output: EnumValues }

    The input, output and issue type.

    async: false

    Whether it's async.

    enum: TEnum

    The enum object.

    expects: string

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    options: EnumValues<TEnum>[]

    The enum options.

    reference: {
        <const TEnum extends Enum>(enum__: TEnum): EnumSchema<TEnum, undefined>;
        <
            const TEnum extends Enum,
            const TMessage extends ErrorMessage<EnumIssue> | undefined,
        >(
            enum__: TEnum,
            message: TMessage,
        ): EnumSchema<TEnum, TMessage>;
    }

    The schema reference.

    Type Declaration

      • <const TEnum extends Enum>(enum__: TEnum): EnumSchema<TEnum, undefined>

      • Creates an enum schema.

        Type Parameters

        • const TEnum extends Enum

        Parameters

        • enum__: TEnum

          The enum object.

        Returns EnumSchema<TEnum, undefined>

        An enum schema.

      • <
            const TEnum extends Enum,
            const TMessage extends ErrorMessage<EnumIssue> | undefined,
        >(
            enum__: TEnum,
            message: TMessage,
        ): EnumSchema<TEnum, TMessage>

      • Creates an enum schema.

        Type Parameters

        Parameters

        • enum__: TEnum

          The enum object.

        • message: TMessage

          The error message.

        Returns EnumSchema<TEnum, TMessage>

        An enum schema.

    type: "enum"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties