Interface ReadonlyAction<TInput>

Readonly action interface.

interface ReadonlyAction<TInput> {
    "~run": (
        dataset: SuccessDataset<TInput>,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<Readonly<TInput>, BaseIssue<unknown>>;
    "~types"?: { input: TInput; issue: never; output: Readonly };
    async: false;
    kind: "transformation";
    reference: <TInput>() => ReadonlyAction<TInput>;
    type: "readonly";
}

Type Parameters

  • TInput

Hierarchy (View Summary)

Properties

~run ~types? async kind reference type

Properties

Readonly Internal~run

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

Transforms known input values.

Type declaration

Optional Readonly Internal~types

"~types"?: { input: TInput; issue: never; output: Readonly }

The input, output and issue type.

Readonlyasync

async: false

Whether it's async.

Readonlykind

kind: "transformation"

The object kind.

Readonlyreference

reference: <TInput>() => ReadonlyAction<TInput>

The action reference.

Type declaration

Readonlytype

type: "readonly"

The action type.

Settings

Member Visibility

On This Page

Properties