mini-effect
    Preparing search index...

    Interface PicklistSchema<TOptions$1, TMessage>

    Picklist schema interface.

    interface PicklistSchema<
        TOptions$1 extends PicklistOptions,
        TMessage extends ErrorMessage<PicklistIssue> | undefined,
    > {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<TOptions$1[number], PicklistIssue>;
        "~standard": StandardProps<TOptions$1[number], TOptions$1[number]>;
        "~types"?: {
            input: TOptions$1[number];
            issue: PicklistIssue;
            output: TOptions$1[number];
        };
        async: false;
        expects: string;
        kind: "schema";
        message: TMessage;
        options: TOptions$1;
        reference: {
            <const TOptions$1 extends PicklistOptions>(
                options: TOptions$1,
            ): PicklistSchema<TOptions$1, undefined>;
            <
                const TOptions$1 extends PicklistOptions,
                const TMessage extends ErrorMessage<PicklistIssue> | undefined,
            >(
                options: TOptions$1,
                message: TMessage,
            ): PicklistSchema<TOptions$1, TMessage>;
        };
        type: "picklist";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<TOptions$1[number], PicklistIssue>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<TOptions$1[number], TOptions$1[number]>

    The Standard Schema properties.

    "~types"?: {
        input: TOptions$1[number];
        issue: PicklistIssue;
        output: TOptions$1[number];
    }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: string

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

    options: TOptions$1

    The picklist options.

    reference: {
        <const TOptions$1 extends PicklistOptions>(
            options: TOptions$1,
        ): PicklistSchema<TOptions$1, undefined>;
        <
            const TOptions$1 extends PicklistOptions,
            const TMessage extends ErrorMessage<PicklistIssue> | undefined,
        >(
            options: TOptions$1,
            message: TMessage,
        ): PicklistSchema<TOptions$1, TMessage>;
    }

    The schema reference.

    Type Declaration

    type: "picklist"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties