mini-effect
    Preparing search index...

    Interface CheckItemsAction<TInput$1, TMessage>

    Check items action interface.

    interface CheckItemsAction<
        TInput$1 extends ArrayInput,
        TMessage extends ErrorMessage<CheckItemsIssue<TInput$1>> | undefined,
    > {
        "~run": (
            dataset: OutputDataset<TInput$1, BaseIssue<unknown>>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            TInput$1,
            BaseIssue<unknown>
            | CheckItemsIssue<TInput$1>,
        >;
        "~types"?: { input: TInput$1; issue: CheckItemsIssue; output: TInput$1 };
        async: false;
        expects: null;
        kind: "validation";
        message: TMessage;
        reference: {
            <TInput$1 extends ArrayInput>(
                requirement: ArrayRequirement<TInput$1>,
            ): CheckItemsAction<TInput$1, undefined>;
            <
                TInput$1 extends ArrayInput,
                const TMessage extends
                    ErrorMessage<CheckItemsIssue<TInput$1>> | undefined,
            >(
                requirement: ArrayRequirement<TInput$1>,
                message: TMessage,
            ): CheckItemsAction<TInput$1, TMessage>;
        };
        requirement: ArrayRequirement<TInput$1>;
        type: "check_items";
    }

    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>>,
    ) => OutputDataset<TInput$1, BaseIssue<unknown> | CheckItemsIssue<TInput$1>>

    Validates known input values.

    Type Declaration

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

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: null

    The expected property.

    kind: "validation"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <TInput$1 extends ArrayInput>(
            requirement: ArrayRequirement<TInput$1>,
        ): CheckItemsAction<TInput$1, undefined>;
        <
            TInput$1 extends ArrayInput,
            const TMessage extends ErrorMessage<CheckItemsIssue<TInput$1>> | undefined,
        >(
            requirement: ArrayRequirement<TInput$1>,
            message: TMessage,
        ): CheckItemsAction<TInput$1, TMessage>;
    }

    The action reference.

    Type Declaration

    requirement: ArrayRequirement<TInput$1>

    The validation function.

    type: "check_items"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties