Interface BaseSchema<TInput, TOutput, TIssue>

Base schema interface.

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

Type Parameters

TInput
TOutput
TIssue extends BaseIssue<unknown>

Hierarchy (View Summary)

BaseSchema

Index

Properties

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

Properties

`Readonly` `Internal`~run

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

Parses unknown input values.

Type declaration

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

`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.

`Readonly`async

async: false

Whether it's async.

`Readonly`expects

expects: string

The expected property.

`Readonly`kind

kind: "schema"

The object kind.

`Readonly`reference

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

The schema reference.

`Readonly`type

type: string

The schema type.