Interface BaseValidationAsync<TInput$1, TOutput$1, TIssue>

Base validation async interface.

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

Type Parameters

TInput$1
TOutput$1
TIssue extends BaseIssue<unknown>

Hierarchy (View Summary)

Omit<
BaseValidation<TInput$1, TOutput$1, TIssue>,
"reference" | "async" | "~run",
>
- BaseValidationAsync

Index

Properties

~run ~types? async expects kind reference type

Properties

`Readonly` `Internal`~run

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

Validates known input values.

Type Declaration

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

`Optional` `Readonly` `Internal`~types

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

The input, output and issue type.

`Readonly`async

async: true

Whether it's async.

`Readonly`expects

expects: string | null

The expected property.

`Readonly`kind

kind: "validation"

The object kind.

`Readonly`reference

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

The validation reference.

`Readonly`type

type: string

The validation type.