mini-effect
    Preparing search index...

    Interface TransformActionAsync<TInput$1, TOutput$1>

    Transform action async interface.

    interface TransformActionAsync<TInput$1, TOutput$1> {
        "~run": (
            dataset: SuccessDataset<TInput$1>,
            config: Config<BaseIssue<unknown>>,
        ) => Promise<OutputDataset<TOutput$1, BaseIssue<unknown>>>;
        "~types"?: { input: TInput$1; issue: never; output: TOutput$1 };
        async: true;
        kind: "transformation";
        operation: (input: TInput$1) => Promise<TOutput$1>;
        reference: <TInput$1, TOutput$1>(
            operation: (input: TInput$1) => Promise<TOutput$1>,
        ) => TransformActionAsync<TInput$1, TOutput$1>;
        type: "transform";
    }

    Type Parameters

    • TInput$1
    • TOutput$1

    Hierarchy (View Summary)

    Index

    Properties

    ~run ~types? async kind operation reference type

    Properties

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

    Transforms known input values.

    Type Declaration

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

    The input, output and issue type.

    async: true

    Whether it's async.

    kind: "transformation"

    The object kind.

    operation: (input: TInput$1) => Promise<TOutput$1>

    The transformation operation.

    reference: <TInput$1, TOutput$1>(
        operation: (input: TInput$1) => Promise<TOutput$1>,
    ) => TransformActionAsync<TInput$1, TOutput$1>

    The action reference.

    Type Declaration

      • <TInput$1, TOutput$1>(
            operation: (input: TInput$1) => Promise<TOutput$1>,
        ): TransformActionAsync<TInput$1, TOutput$1>

      • Creates a custom transformation action.

        Type Parameters

        • TInput$1
        • TOutput$1

        Parameters

        • operation: (input: TInput$1) => Promise<TOutput$1>

          The transformation operation.

        Returns TransformActionAsync<TInput$1, TOutput$1>

        A transform action.

    type: "transform"

    The action type.

    Settings

    Member Visibility

    On This Page

    Properties