Interface FlavorAction<TInput$1, TName>`Beta`

Flavor action interface.

interface FlavorAction<TInput$1, TName extends FlavorName> {
    "~run": (
        dataset: SuccessDataset<TInput$1>,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<TInput$1 & Flavor<TName>, BaseIssue<unknown>>;
    "~types"?: {
        input: TInput$1;
        issue: never;
        output: TInput$1 & Flavor<TName>;
    };
    async: false;
    kind: "transformation";
    name: TName;
    reference: <TInput$1, TName extends FlavorName>(
        name: TName,
    ) => FlavorAction<TInput$1, TName>;
    type: "flavor";
}

Type Parameters

TInput$1
TName extends FlavorName

Hierarchy (View Summary)

BaseTransformation<TInput$1, TInput$1 & Flavor<TName>, never>
- FlavorAction

Index

Properties

~run ~types? async kind name reference type

Properties

`Readonly` `Internal`~run

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

Transforms known input values.

Type Declaration

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

`Optional` `Readonly` `Internal`~types

"~types"?: { input: TInput$1; issue: never; output: TInput$1 & Flavor<TName> }

The input, output and issue type.

`Readonly` `Beta`async

async: false

Whether it's async.

`Readonly` `Beta`kind

kind: "transformation"

The object kind.

`Readonly` `Beta`name

name: TName

The flavor name.

`Readonly` `Beta`reference

reference: <TInput$1, TName extends FlavorName>(
name: TName,
) => FlavorAction<TInput$1, TName>

The action reference.

Type Declaration

- <TInput$1, TName extends FlavorName>(name: TName): FlavorAction<TInput$1, TName>
- Beta
  Creates a flavor transformation action.
  Type Parameters
  - TInput$1
  - TName extends FlavorName
  Parameters
  - name: TName
    The flavor name.
  Returns FlavorAction<TInput$1, TName>
  A flavor action.

`Readonly` `Beta`type

type: "flavor"

The action type.