mini-effect
    Preparing search index...

    Interface StringSchema<TMessage>

    String schema interface.

    interface StringSchema<TMessage extends ErrorMessage<StringIssue> | undefined> {
        "~run": (
            dataset: UnknownDataset,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<string, StringIssue>;
        "~standard": StandardProps<string, string>;
        "~types"?: { input: string; issue: StringIssue; output: string };
        async: false;
        expects: "string";
        kind: "schema";
        message: TMessage;
        reference: {
            (): StringSchema<undefined>;
            <const TMessage extends ErrorMessage<StringIssue> | undefined>(
                message: TMessage,
            ): StringSchema<TMessage>;
        };
        type: "string";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<string, StringIssue>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<string, string>

    The Standard Schema properties.

    "~types"?: { input: string; issue: StringIssue; output: string }

    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.

    reference: {
        (): StringSchema<undefined>;
        <const TMessage extends ErrorMessage<StringIssue> | undefined>(
            message: TMessage,
        ): StringSchema<TMessage>;
    }

    The schema reference.

    Type Declaration

    type: "string"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties