mini-effect
    Preparing search index...

    Interface CheckActionAsync<TInput$1, TMessage>

    Check action async interface.

    interface CheckActionAsync<
        TInput$1,
        TMessage extends ErrorMessage<CheckIssue<TInput$1>> | undefined,
    > {
        "~run": (
            dataset: OutputDataset<TInput$1, BaseIssue<unknown>>,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<
            OutputDataset<TInput$1, BaseIssue<unknown> | CheckIssue<TInput$1>>,
        >;
        "~types"?: { input: TInput$1; issue: CheckIssue; output: TInput$1 };
        async: true;
        expects: null;
        kind: "validation";
        message: TMessage;
        reference: {
            <TInput$1>(
                requirement: (input: TInput$1) => MaybePromise<boolean>,
            ): CheckActionAsync<TInput$1, undefined>;
            <
                TInput$1,
                const TMessage extends ErrorMessage<CheckIssue<TInput$1>> | undefined,
            >(
                requirement: (input: TInput$1) => MaybePromise<boolean>,
                message: TMessage,
            ): CheckActionAsync<TInput$1, TMessage>;
        };
        requirement: (input: TInput$1) => MaybePromise<boolean>;
        type: "check";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

    "~run": (
        dataset: OutputDataset<TInput$1, BaseIssue<unknown>>,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<
        OutputDataset<TInput$1, BaseIssue<unknown> | CheckIssue<TInput$1>>,
    >

    Validates known input values.

    Type Declaration

    "~types"?: { input: TInput$1; issue: CheckIssue; output: TInput$1 }

    The input, output and issue type.

    async: true

    Whether it's async.

    expects: null

    The expected property.

    kind: "validation"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <TInput$1>(
            requirement: (input: TInput$1) => MaybePromise<boolean>,
        ): CheckActionAsync<TInput$1, undefined>;
        <
            TInput$1,
            const TMessage extends ErrorMessage<CheckIssue<TInput$1>> | undefined,
        >(
            requirement: (input: TInput$1) => MaybePromise<boolean>,
            message: TMessage,
        ): CheckActionAsync<TInput$1, TMessage>;
    }

    The action reference.

    Type Declaration

      • <TInput$1>(
            requirement: (input: TInput$1) => MaybePromise<boolean>,
        ): CheckActionAsync<TInput$1, undefined>

      • Creates a check validation action.

        Type Parameters

        • TInput$1

        Parameters

        • requirement: (input: TInput$1) => MaybePromise<boolean>

          The validation function.

        Returns CheckActionAsync<TInput$1, undefined>

        A check action.

      • <
            TInput$1,
            const TMessage extends ErrorMessage<CheckIssue<TInput$1>> | undefined,
        >(
            requirement: (input: TInput$1) => MaybePromise<boolean>,
            message: TMessage,
        ): CheckActionAsync<TInput$1, TMessage>

      • Creates a check validation action.

        Type Parameters

        Parameters

        • requirement: (input: TInput$1) => MaybePromise<boolean>

          The validation function.

        • message: TMessage

          The error message.

        Returns CheckActionAsync<TInput$1, TMessage>

        A check action.

    requirement: (input: TInput$1) => MaybePromise<boolean>

    The validation function.

    type: "check"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties