mini-effect
    Preparing search index...

    Interface ToMaxValueAction<TInput$1, TRequirement>

    To max value action interface.

    interface ToMaxValueAction<
        TInput$1 extends ValueInput,
        TRequirement extends TInput$1,
    > {
        "~run": (
            dataset: SuccessDataset<TInput$1>,
            config: Config<BaseIssue<unknown>>,
        ) => OutputDataset<TInput$1, BaseIssue<unknown>>;
        "~types"?: { input: TInput$1; issue: never; output: TInput$1 };
        async: false;
        kind: "transformation";
        reference: <
            TInput$1 extends ValueInput,
            const TRequirement extends ValueInput,
        >(
            requirement: TRequirement,
        ) => ToMaxValueAction<TInput$1, TRequirement>;
        requirement: TRequirement;
        type: "to_max_value";
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~types? async kind reference requirement type

    Properties

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

    Transforms known input values.

    Type Declaration

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

    The input, output and issue type.

    async: false

    Whether it's async.

    kind: "transformation"

    The object kind.

    reference: <TInput$1 extends ValueInput, const TRequirement extends ValueInput>(
        requirement: TRequirement,
    ) => ToMaxValueAction<TInput$1, TRequirement>

    The action reference.

    Type Declaration

      • <TInput$1 extends ValueInput, const TRequirement extends ValueInput>(
            requirement: TRequirement,
        ): ToMaxValueAction<TInput$1, TRequirement>

      • Creates a to max value transformation action.

        Type Parameters

        Parameters

        • requirement: TRequirement

          The maximum value.

        Returns ToMaxValueAction<TInput$1, TRequirement>

        A to max value action.

    requirement: TRequirement

    The maximum value.

    type: "to_max_value"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties