mini-effect
    Preparing search index...

    Interface RfcEmailAction<TInput$1, TMessage>

    RFC email action interface.

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

    Validates known input values.

    Type Declaration

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

    The action reference.

    Type Declaration

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

      • Creates a RFC email validation action.

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

        Type Parameters

        • TInput$1 extends string

        Returns RfcEmailAction<TInput$1, undefined>

        A RFC email action.

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

      • Creates a RFC email validation action.

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

        Type Parameters

        Parameters

        • message: TMessage

          The error message.

        Returns RfcEmailAction<TInput$1, TMessage>

        A RFC email action.

    requirement: RegExp

    The RFC email regex.

    type: "rfc_email"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties