mini-effect
    Preparing search index...

    Interface MaxWordsAction<TInput$1, TLocales, TRequirement, TMessage>

    Max words action interface.

    interface MaxWordsAction<
        TInput$1 extends string,
        TLocales extends Intl.LocalesArgument,
        TRequirement extends number,
        TMessage extends
            ErrorMessage<MaxWordsIssue<TInput$1, TRequirement>> | undefined,
    > {
        "~run": (
            dataset: OutputDataset<TInput$1, BaseIssue<unknown>>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<
            TInput$1,
            BaseIssue<unknown>
            | MaxWordsIssue<TInput$1, TRequirement>,
        >;
        "~types"?: { input: TInput$1; issue: MaxWordsIssue; output: TInput$1 };
        async: false;
        expects: `<=${TRequirement}`;
        kind: "validation";
        locales: TLocales;
        message: TMessage;
        reference: {
            <
                TInput$1 extends string,
                TLocales extends LocalesArgument,
                const TRequirement extends number,
            >(
                locales: TLocales,
                requirement: TRequirement,
            ): MaxWordsAction<TInput$1, TLocales, TRequirement, undefined>;
            <
                TInput$1 extends string,
                TLocales extends LocalesArgument,
                const TRequirement extends number,
                const TMessage extends
                    ErrorMessage<MaxWordsIssue<TInput$1, TRequirement>> | undefined,
            >(
                locales: TLocales,
                requirement: TRequirement,
                message: TMessage,
            ): MaxWordsAction<TInput$1, TLocales, TRequirement, TMessage>;
        };
        requirement: TRequirement;
        type: "max_words";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

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

    Properties

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

    Validates known input values.

    Type Declaration

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

    The input, output and issue type.

    async: false

    Whether it's async.

    expects: `<=${TRequirement}`

    The expected property.

    kind: "validation"

    The object kind.

    locales: TLocales

    The locales to be used.

    message: TMessage

    The error message.

    reference: {
        <
            TInput$1 extends string,
            TLocales extends LocalesArgument,
            const TRequirement extends number,
        >(
            locales: TLocales,
            requirement: TRequirement,
        ): MaxWordsAction<TInput$1, TLocales, TRequirement, undefined>;
        <
            TInput$1 extends string,
            TLocales extends LocalesArgument,
            const TRequirement extends number,
            const TMessage extends
                ErrorMessage<MaxWordsIssue<TInput$1, TRequirement>> | undefined,
        >(
            locales: TLocales,
            requirement: TRequirement,
            message: TMessage,
        ): MaxWordsAction<TInput$1, TLocales, TRequirement, TMessage>;
    }

    The action reference.

    Type Declaration

      • <
            TInput$1 extends string,
            TLocales extends LocalesArgument,
            const TRequirement extends number,
        >(
            locales: TLocales,
            requirement: TRequirement,
        ): MaxWordsAction<TInput$1, TLocales, TRequirement, undefined>

      • Creates a max words validation action.

        Type Parameters

        • TInput$1 extends string
        • TLocales extends LocalesArgument
        • const TRequirement extends number

        Parameters

        • locales: TLocales

          The locales to be used.

        • requirement: TRequirement

          The maximum words.

        Returns MaxWordsAction<TInput$1, TLocales, TRequirement, undefined>

        A max words action.

      • <
            TInput$1 extends string,
            TLocales extends LocalesArgument,
            const TRequirement extends number,
            const TMessage extends
                ErrorMessage<MaxWordsIssue<TInput$1, TRequirement>> | undefined,
        >(
            locales: TLocales,
            requirement: TRequirement,
            message: TMessage,
        ): MaxWordsAction<TInput$1, TLocales, TRequirement, TMessage>

      • Creates a max words validation action.

        Type Parameters

        • TInput$1 extends string
        • TLocales extends LocalesArgument
        • const TRequirement extends number
        • const TMessage extends ErrorMessage<MaxWordsIssue<TInput$1, TRequirement>> | undefined

        Parameters

        • locales: TLocales

          The locales to be used.

        • requirement: TRequirement

          The maximum words.

        • message: TMessage

          The error message.

        Returns MaxWordsAction<TInput$1, TLocales, TRequirement, TMessage>

        A max words action.

    requirement: TRequirement

    The maximum words.

    type: "max_words"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties