Interface BrandAction<TInput$1, TName>

Brand action interface.

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

Type Parameters

TInput$1
TName extends BrandName

Hierarchy (View Summary)

BaseTransformation<TInput$1, TInput$1 & Brand<TName>, never>
- BrandAction

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 & Brand<TName>, BaseIssue<unknown>>

Transforms known input values.

Type Declaration

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

`Optional` `Readonly` `Internal`~types

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

The input, output and issue type.

`Readonly`async

async: false

Whether it's async.

`Readonly`kind

kind: "transformation"

The object kind.

`Readonly`name

name: TName

The brand name.

`Readonly`reference

reference: <TInput$1, TName extends BrandName>(
name: TName,
) => BrandAction<TInput$1, TName>

The action reference.

Type Declaration

- <TInput$1, TName extends BrandName>(name: TName): BrandAction<TInput$1, TName>
- Creates a brand transformation action.
  Type Parameters
  - TInput$1
  - TName extends BrandName
  Parameters
  - name: TName
    The brand name.
  Returns BrandAction<TInput$1, TName>
  A brand action.

`Readonly`type

type: "brand"

The action type.