Interface BaseTransformation<TInput, TOutput, TIssue>

Base transformation interface.

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

Type Parameters

TInput
TOutput
TIssue extends BaseIssue<unknown>

Hierarchy (View Summary)

BaseTransformation
- ReadonlyAction

Index

Properties

~run ~types? async kind reference type

Properties

`Readonly` `Internal`~run

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

Transforms known input values.

Type declaration

- (
  dataset: SuccessDataset<TInput>,
  config: Config<BaseIssue<unknown>>,
  ): OutputDataset<TOutput, BaseIssue<unknown> | TIssue>
- Parameters
  - dataset: SuccessDataset<TInput>
    The input dataset.
  - config: Config<BaseIssue<unknown>>
    The configuration.
  Returns OutputDataset<TOutput, BaseIssue<unknown> | TIssue>
  The output dataset.

`Optional` `Readonly` `Internal`~types

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

The input, output and issue type.

`Readonly`async

async: false

Whether it's async.

`Readonly`kind

kind: "transformation"

The object kind.

`Readonly`reference

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

The transformation reference.

`Readonly`type

type: string

The transformation type.