Interface BaseTransformation<TInput$1, TOutput$1, TIssue>

Base transformation interface.

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

Type Parameters

TInput$1
TOutput$1
TIssue extends BaseIssue<unknown>

Index

Properties

~run ~types? async kind reference type

Properties

`Readonly` `Internal`~run

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

Transforms known input values.

Type Declaration

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

`Optional` `Readonly` `Internal`~types

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

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.