Interface FilterItemsAction<TInput$1>

Filter items action interface.

interface FilterItemsAction<TInput$1 extends ArrayInput> {
    "~run": (
        dataset: SuccessDataset<TInput$1>,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<TInput$1, BaseIssue<unknown>>;
    "~types"?: { input: TInput$1; issue: never; output: TInput$1 };
    async: false;
    kind: "transformation";
    operation: ArrayRequirement<TInput$1>;
    reference: <TInput$1 extends ArrayInput>(
        operation: ArrayRequirement<TInput$1>,
    ) => FilterItemsAction<TInput$1>;
    type: "filter_items";
}

Type Parameters

TInput$1 extends ArrayInput

Hierarchy (View Summary)

BaseTransformation<TInput$1, TInput$1, never>
- FilterItemsAction

Index

Properties

~run ~types? async kind operation reference type

Properties

`Readonly` `Internal`~run

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

Transforms known input values.

Type Declaration

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

`Optional` `Readonly` `Internal`~types

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

The input, output and issue type.

`Readonly`async

async: false

Whether it's async.

`Readonly`kind

kind: "transformation"

The object kind.

`Readonly`operation

operation: ArrayRequirement<TInput$1>

The filter items operation.

`Readonly`reference

reference: <TInput$1 extends ArrayInput>(
operation: ArrayRequirement<TInput$1>,
) => FilterItemsAction<TInput$1>

The action reference.

Type Declaration

- <TInput$1 extends ArrayInput>(
  operation: ArrayRequirement<TInput$1>,
  ): FilterItemsAction<TInput$1>
- Creates a filter items transformation action.
  Type Parameters
  - TInput$1 extends ArrayInput
  Parameters
  - operation: ArrayRequirement<TInput$1>
    The filter items operation.
  Returns FilterItemsAction<TInput$1>
  A filter items action.

`Readonly`type

type: "filter_items"

The action type.