mini-effect
    Preparing search index...

    Interface IsoWeekAction<TInput$1, TMessage>

    ISO week action interface.

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

    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> | IsoWeekIssue<TInput$1>>

    Validates known input values.

    Type Declaration

    "~types"?: { input: TInput$1; issue: IsoWeekIssue; 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 string>(): IsoWeekAction<TInput$1, undefined>;
        <
            TInput$1 extends string,
            const TMessage extends ErrorMessage<IsoWeekIssue<TInput$1>> | undefined,
        >(
            message: TMessage,
        ): IsoWeekAction<TInput$1, TMessage>;
    }

    The action reference.

    Type Declaration

      • <TInput$1 extends string>(): IsoWeekAction<TInput$1, undefined>

      • Creates an ISO week validation action.

        Format: yyyy-Www

        Hint: The regex used cannot validate the maximum number of weeks based on the year. For example, "2021W53" is valid although 2021 has only 52 weeks.

        Type Parameters

        • TInput$1 extends string

        Returns IsoWeekAction<TInput$1, undefined>

        An ISO week action.

      • <
            TInput$1 extends string,
            const TMessage extends ErrorMessage<IsoWeekIssue<TInput$1>> | undefined,
        >(
            message: TMessage,
        ): IsoWeekAction<TInput$1, TMessage>

      • Creates an ISO week validation action.

        Format: yyyy-Www

        Hint: The regex used cannot validate the maximum number of weeks based on the year. For example, "2021W53" is valid although 2021 has only 52 weeks.

        Type Parameters

        Parameters

        • message: TMessage

          The error message.

        Returns IsoWeekAction<TInput$1, TMessage>

        An ISO week action.

    requirement: RegExp

    The ISO week regex.

    type: "iso_week"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties