mini-effect
    Preparing search index...

    Interface PromiseSchema<TMessage>

    Promise schema interface.

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

    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<Promise<unknown>, PromiseIssue>

    Parses unknown input values.

    Type Declaration

    "~standard": StandardProps<Promise<unknown>, Promise<unknown>>

    The Standard Schema properties.

    "~types"?: { input: Promise; issue: PromiseIssue; output: Promise }

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: "Promise"

    The expected property.

    kind: "schema"

    The object kind.

    message: TMessage

    The error message.

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

    The schema reference.

    Type Declaration

    type: "promise"

    The schema type.

    Settings

    Member Visibility

    On This Page

    Properties