Interface AwaitActionAsync<TInput$1>

Await action async interface.

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

Type Parameters

TInput$1 extends Promise<unknown>

Hierarchy (View Summary)

BaseTransformationAsync<TInput$1, Awaited<TInput$1>, never>
- AwaitActionAsync

Index

Properties

~run ~types? async kind reference type

Properties

`Readonly` `Internal`~run

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

Transforms known input values.

Type Declaration

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

`Optional` `Readonly` `Internal`~types

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

The input, output and issue type.

`Readonly`async

async: true

Whether it's async.

`Readonly`kind

kind: "transformation"

The object kind.

`Readonly`reference

reference: <TInput$1 extends Promise<unknown>>() => AwaitActionAsync<TInput$1>

The action reference.

Type Declaration

- <TInput$1 extends Promise<unknown>>(): AwaitActionAsync<TInput$1>
- Creates an await transformation action.
  Type Parameters
  - TInput$1 extends Promise<unknown>
  Returns AwaitActionAsync<TInput$1>
  An await action.

`Readonly`type

type: "await"

The action type.