mini-effect
    Preparing search index...

    Interface PartialCheckAction<TInput$1, TPaths, TSelection, TMessage>

    Partial check action interface.

    interface PartialCheckAction<
        TInput$1 extends PartialInput,
        TPaths extends Paths,
        TSelection extends DeepPickN<TInput$1, TPaths>,
        TMessage extends ErrorMessage<PartialCheckIssue<TSelection>> | undefined,
    > {
        "~run": (
            dataset: OutputDataset<TInput$1, BaseIssue<unknown>>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            TInput$1,
            BaseIssue<unknown>
            | PartialCheckIssue<TSelection>,
        >;
        "~types"?: { input: TInput$1; issue: PartialCheckIssue; output: TInput$1 };
        async: false;
        expects: null;
        kind: "validation";
        message: TMessage;
        paths: TPaths;
        reference: {
            <
                TInput$1 extends PartialInput,
                const TPaths extends RequiredPaths,
                const TSelection extends
                
                        | { [key: string]: never }
                        | never[]
                        | {
                            length: never;
                            readonly [key: number]: never;
                            [key: string]: unknown;
                        },
            >(
                paths: ValidPaths<TInput$1, TPaths>,
                requirement: (input: TSelection) => boolean,
            ): PartialCheckAction<TInput$1, TPaths, TSelection, undefined>;
            <
                TInput$1 extends PartialInput,
                const TPaths extends RequiredPaths,
                const TSelection extends
                
                        | { [key: string]: never }
                        | never[]
                        | {
                            length: never;
                            readonly [key: number]: never;
                            [key: string]: unknown;
                        },
                const TMessage extends
                    ErrorMessage<PartialCheckIssue<TSelection>>
                    | undefined,
            >(
                paths: ValidPaths<TInput$1, TPaths>,
                requirement: (input: TSelection) => boolean,
                message: TMessage,
            ): PartialCheckAction<TInput$1, TPaths, TSelection, TMessage>;
        };
        requirement: (input: TSelection) => boolean;
        type: "partial_check";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

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

    Validates known input values.

    Type Declaration

    "~types"?: { input: TInput$1; issue: PartialCheckIssue; 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.

    paths: TPaths

    The selected paths.

    reference: {
        <
            TInput$1 extends PartialInput,
            const TPaths extends RequiredPaths,
            const TSelection extends
            
                    | { [key: string]: never }
                    | never[]
                    | {
                        length: never;
                        readonly [key: number]: never;
                        [key: string]: unknown;
                    },
        >(
            paths: ValidPaths<TInput$1, TPaths>,
            requirement: (input: TSelection) => boolean,
        ): PartialCheckAction<TInput$1, TPaths, TSelection, undefined>;
        <
            TInput$1 extends PartialInput,
            const TPaths extends RequiredPaths,
            const TSelection extends
            
                    | { [key: string]: never }
                    | never[]
                    | {
                        length: never;
                        readonly [key: number]: never;
                        [key: string]: unknown;
                    },
            const TMessage extends
                ErrorMessage<PartialCheckIssue<TSelection>>
                | undefined,
        >(
            paths: ValidPaths<TInput$1, TPaths>,
            requirement: (input: TSelection) => boolean,
            message: TMessage,
        ): PartialCheckAction<TInput$1, TPaths, TSelection, TMessage>;
    }

    The action reference.

    Type Declaration

      • <
            TInput$1 extends PartialInput,
            const TPaths extends RequiredPaths,
            const TSelection extends
            
                    | { [key: string]: never }
                    | never[]
                    | {
                        length: never;
                        readonly [key: number]: never;
                        [key: string]: unknown;
                    },
        >(
            paths: ValidPaths<TInput$1, TPaths>,
            requirement: (input: TSelection) => boolean,
        ): PartialCheckAction<TInput$1, TPaths, TSelection, undefined>

      • Creates a partial check validation action.

        Type Parameters

        • TInput$1 extends PartialInput
        • const TPaths extends RequiredPaths
        • const TSelection extends
              | { [key: string]: never }
              | never[]
              | { length: never; readonly [key: number]: never; [key: string]: unknown }

        Parameters

        • paths: ValidPaths<TInput$1, TPaths>

          The selected paths.

        • requirement: (input: TSelection) => boolean

          The validation function.

        Returns PartialCheckAction<TInput$1, TPaths, TSelection, undefined>

        A partial check action.

      • <
            TInput$1 extends PartialInput,
            const TPaths extends RequiredPaths,
            const TSelection extends
            
                    | { [key: string]: never }
                    | never[]
                    | {
                        length: never;
                        readonly [key: number]: never;
                        [key: string]: unknown;
                    },
            const TMessage extends
                ErrorMessage<PartialCheckIssue<TSelection>>
                | undefined,
        >(
            paths: ValidPaths<TInput$1, TPaths>,
            requirement: (input: TSelection) => boolean,
            message: TMessage,
        ): PartialCheckAction<TInput$1, TPaths, TSelection, TMessage>

      • Creates a partial check validation action.

        Type Parameters

        • TInput$1 extends PartialInput
        • const TPaths extends RequiredPaths
        • const TSelection extends
              | { [key: string]: never }
              | never[]
              | { length: never; readonly [key: number]: never; [key: string]: unknown }
        • const TMessage extends ErrorMessage<PartialCheckIssue<TSelection>> | undefined

        Parameters

        • paths: ValidPaths<TInput$1, TPaths>

          The selected paths.

        • requirement: (input: TSelection) => boolean

          The validation function.

        • message: TMessage

          The error message.

        Returns PartialCheckAction<TInput$1, TPaths, TSelection, TMessage>

        A partial check action.

    requirement: (input: TSelection) => boolean

    The validation function.

    type: "partial_check"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties