mini-effect
    Preparing search index...

    Interface EmailAction<TInput$1, TMessage>

    Email action interface.

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

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

    Validates known input values.

    Type Declaration

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

    The action reference.

    Type Declaration

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

      • Creates an email validation action.

        Hint: This validation action intentionally only validates common email addresses. If you are interested in an action that covers the entire specification, please use the rfcEmail action instead.

        Type Parameters

        • TInput$1 extends string

        Returns EmailAction<TInput$1, undefined>

        An email action.

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

      • Creates an email validation action.

        Hint: This validation action intentionally only validates common email addresses. If you are interested in an action that covers the entire specification, please use the rfcEmail action instead.

        Type Parameters

        Parameters

        • message: TMessage

          The error message.

        Returns EmailAction<TInput$1, TMessage>

        An email action.

    requirement: RegExp

    The email regex.

    type: "email"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties