Interface PicklistSchema<TOptions, TMessage>

Picklist schema interface.

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

Type Parameters

Hierarchy (View Summary)

Properties

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

Properties

Readonly Internal~run

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

Parses unknown input values.

Type declaration

Readonly Internal~standard

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

The Standard Schema properties.

Optional Readonly Internal~types

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

The input, output and issue type.

Readonlyasync

async: false

Whether it's async.

Readonlyexpects

expects: string

The expected property.

Readonlykind

kind: "schema"

The object kind.

Readonlymessage

message: TMessage

The error message.

Readonlyoptions

options: TOptions

The picklist options.

Readonlyreference

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

The schema reference.

Type declaration

Readonlytype

type: "picklist"

The schema type.

Settings

Member Visibility

On This Page

Properties