Interface BaseTransformationAsync<TInput, TOutput, TIssue>

Base transformation async interface.

interface BaseTransformationAsync<
    TInput,
    TOutput,
    TIssue extends BaseIssue<unknown>,
> {
    "~run": (
        dataset: SuccessDataset<TInput>,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<OutputDataset<TOutput, BaseIssue<unknown> | TIssue>>;
    "~types"?: { input: TInput; issue: TIssue; output: TOutput };
    async: true;
    kind: "transformation";
    reference: (
        ...args: any[],
    ) =>
        | BaseTransformation<any, any, BaseIssue<unknown>>
        | BaseTransformationAsync<any, any, BaseIssue<unknown>>;
    type: string;
}

Type Parameters

  • TInput
  • TOutput
  • TIssue extends BaseIssue<unknown>

Hierarchy (View Summary)

Properties

~run ~types? async kind reference type

Properties

Readonly Internal~run

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

Transforms known input values.

Type declaration

Optional Readonly Internal~types

"~types"?: { input: TInput; issue: TIssue; output: TOutput }

The input, output and issue type.

Readonlyasync

async: true

Whether it's async.

Readonlykind

kind: "transformation"

The object kind.

Readonlyreference

reference: (
    ...args: any[],
) =>
    | BaseTransformation<any, any, BaseIssue<unknown>>
    | BaseTransformationAsync<any, any, BaseIssue<unknown>>

The transformation reference.

Readonlytype

type: string

The transformation type.

Settings

Member Visibility

On This Page

Properties