mini-effect
    Preparing search index...

    Interface ToNumberAction<TInput$1, TMessage>

    To number action interface.

    interface ToNumberAction<
        TInput$1,
        TMessage extends ErrorMessage<ToNumberIssue<TInput$1>> | undefined,
    > {
        "~run": (
            dataset: SuccessDataset<TInput$1>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<number, BaseIssue<unknown> | ToNumberIssue<TInput$1>>;
        "~types"?: { input: TInput$1; issue: ToNumberIssue; output: number };
        async: false;
        kind: "transformation";
        message: TMessage;
        reference: {
            <TInput$1>(): ToNumberAction<TInput$1, undefined>;
            <
                TInput$1,
                const TMessage extends ErrorMessage<ToNumberIssue<TInput$1>> | undefined,
            >(
                message: TMessage,
            ): ToNumberAction<TInput$1, TMessage>;
        };
        type: "to_number";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~types? async kind message reference type

    Properties

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

    Transforms known input values.

    Type Declaration

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

    The input, output and issue type.

    async: false

    Whether it's async.

    kind: "transformation"

    The object kind.

    message: TMessage

    The error message.

    reference: {
        <TInput$1>(): ToNumberAction<TInput$1, undefined>;
        <
            TInput$1,
            const TMessage extends ErrorMessage<ToNumberIssue<TInput$1>> | undefined,
        >(
            message: TMessage,
        ): ToNumberAction<TInput$1, TMessage>;
    }

    The action reference.

    Type Declaration

      • <TInput$1>(): ToNumberAction<TInput$1, undefined>
      • Beta

        Creates a to number transformation action.

        Type Parameters

        • TInput$1

        Returns ToNumberAction<TInput$1, undefined>

        A to number action.

      • <
            TInput$1,
            const TMessage extends ErrorMessage<ToNumberIssue<TInput$1>> | undefined,
        >(
            message: TMessage,
        ): ToNumberAction<TInput$1, TMessage>
      • Beta

        Creates a to number transformation action.

        Type Parameters

        Parameters

        • message: TMessage

          The error message.

        Returns ToNumberAction<TInput$1, TMessage>

        A to number action.

    type: "to_number"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties