mini-effect
    Preparing search index...

    Interface IncludesAction<TInput$1, TRequirement, TMessage>

    Includes action interface.

    interface IncludesAction<
        TInput$1 extends ContentInput,
        TRequirement extends ContentRequirement<TInput$1>,
        TMessage extends
            ErrorMessage<IncludesIssue<TInput$1, TRequirement>> | undefined,
    > {
        "~run": (
            dataset: OutputDataset<TInput$1, BaseIssue<unknown>>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            TInput$1,
            BaseIssue<unknown>
            | IncludesIssue<TInput$1, TRequirement>,
        >;
        "~types"?: { input: TInput$1; issue: IncludesIssue; output: TInput$1 };
        async: false;
        expects: string;
        kind: "validation";
        message: TMessage;
        reference: {
            <TInput$1 extends ContentInput, const TRequirement extends unknown>(
                requirement: TRequirement,
            ): IncludesAction<TInput$1, TRequirement, undefined>;
            <
                TInput$1 extends ContentInput,
                const TRequirement extends unknown,
                const TMessage extends
                    ErrorMessage<IncludesIssue<TInput$1, TRequirement>> | undefined,
            >(
                requirement: TRequirement,
                message: TMessage,
            ): IncludesAction<TInput$1, TRequirement, TMessage>;
        };
        requirement: TRequirement;
        type: "includes";
    }

    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>
        | IncludesIssue<TInput$1, TRequirement>,
    >

    Validates known input values.

    Type Declaration

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

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: string

    The expected property.

    kind: "validation"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <TInput$1 extends ContentInput, const TRequirement extends unknown>(
            requirement: TRequirement,
        ): IncludesAction<TInput$1, TRequirement, undefined>;
        <
            TInput$1 extends ContentInput,
            const TRequirement extends unknown,
            const TMessage extends
                ErrorMessage<IncludesIssue<TInput$1, TRequirement>> | undefined,
        >(
            requirement: TRequirement,
            message: TMessage,
        ): IncludesAction<TInput$1, TRequirement, TMessage>;
    }

    The action reference.

    Type Declaration

      • <TInput$1 extends ContentInput, const TRequirement extends unknown>(
            requirement: TRequirement,
        ): IncludesAction<TInput$1, TRequirement, undefined>

      • Creates an includes validation action.

        Type Parameters

        • TInput$1 extends ContentInput
        • const TRequirement extends unknown

        Parameters

        • requirement: TRequirement

          The content to be included.

        Returns IncludesAction<TInput$1, TRequirement, undefined>

        An includes action.

      • <
            TInput$1 extends ContentInput,
            const TRequirement extends unknown,
            const TMessage extends
                ErrorMessage<IncludesIssue<TInput$1, TRequirement>> | undefined,
        >(
            requirement: TRequirement,
            message: TMessage,
        ): IncludesAction<TInput$1, TRequirement, TMessage>

      • Creates an includes validation action.

        Type Parameters

        Parameters

        • requirement: TRequirement

          The content to be included.

        • message: TMessage

          The error message.

        Returns IncludesAction<TInput$1, TRequirement, TMessage>

        An includes action.

    requirement: TRequirement

    The content to be included.

    type: "includes"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties