Interface BaseValidation<TInput, TOutput, TIssue>

Base validation interface.

interface BaseValidation<TInput, TOutput, TIssue extends BaseIssue<unknown>> {
    "~run": (
        dataset: OutputDataset<TInput, BaseIssue<unknown>>,
        config: Config<BaseIssue<unknown>>,
    ) => OutputDataset<TOutput, BaseIssue<unknown> | TIssue>;
    "~types"?: { input: TInput; issue: TIssue; output: TOutput };
    async: false;
    expects: null | string;
    kind: "validation";
    reference: (...args: any[]) => BaseValidation<any, any, BaseIssue<unknown>>;
    type: string;
}

Type Parameters

TInput
TOutput
TIssue extends BaseIssue<unknown>

Index

Properties

~run ~types? async expects kind reference type

Properties

`Readonly` `Internal`~run

"~run": (
dataset: OutputDataset<TInput, BaseIssue<unknown>>,
config: Config<BaseIssue<unknown>>,
) => OutputDataset<TOutput, BaseIssue<unknown> | TIssue>

Validates known input values.

Type declaration

- (
  dataset: OutputDataset<TInput, BaseIssue<unknown>>,
  config: Config<BaseIssue<unknown>>,
  ): OutputDataset<TOutput, BaseIssue<unknown> | TIssue>
- Parameters
  - dataset: OutputDataset<TInput, BaseIssue<unknown>>
    The input dataset.
  - config: Config<BaseIssue<unknown>>
    The configuration.
  Returns OutputDataset<TOutput, BaseIssue<unknown> | TIssue>
  The output dataset.

`Optional` `Readonly` `Internal`~types

"~types"?: { input: TInput; issue: TIssue; output: TOutput }

The input, output and issue type.

`Readonly`async

async: false

Whether it's async.

`Readonly`expects

expects: null | string

The expected property.

`Readonly`kind

kind: "validation"

The object kind.

`Readonly`reference

reference: (...args: any[]) => BaseValidation<any, any, BaseIssue<unknown>>

The validation reference.

`Readonly`type

type: string

The validation type.