Interface BaseSchemaAsync<TInput, TOutput, TIssue>

Base schema async interface.

interface BaseSchemaAsync<TInput, TOutput, TIssue extends BaseIssue<unknown>> {
    "~run": (
        dataset: UnknownDataset,
        config: Config<BaseIssue<unknown>>,
    ) => Promise<OutputDataset<TOutput, TIssue>>;
    "~standard": StandardProps<TInput, TOutput>;
    "~types"?: { input: TInput; issue: TIssue; output: TOutput };
    async: true;
    expects: string;
    kind: "schema";
    reference: (
        ...args: any[],
    ) =>
        | BaseSchema<unknown, unknown, BaseIssue<unknown>>
        | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>;
    type: string;
}

Type Parameters

  • TInput
  • TOutput
  • TIssue extends BaseIssue<unknown>

Hierarchy (View Summary)

Properties

~run ~standard ~types? async expects kind reference type

Properties

Readonly Internal~run

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

Parses unknown input values.

Type declaration

Readonly Internal~standard

"~standard": StandardProps<TInput, TOutput>

The Standard Schema properties.

Optional Readonly Internal~types

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

The input, output and issue type.

Readonlyasync

async: true

Whether it's async.

Readonlyexpects

expects: string

The expected property.

Readonlykind

kind: "schema"

The object kind.

Readonlyreference

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

The schema reference.

Readonlytype

type: string

The schema type.

Settings

Member Visibility

On This Page

Properties