Skip to content

StandardSchemaV1

Types copied from the Standard Schema v1 specification.

Members

Interfaces

FailureResult

A failed validation carrying validation issues.

ts
FailureResult: unknown;

Issue

A single validation issue.

ts
Issue: unknown;

Options

Optional parameters passed to a validator.

ts
Options: unknown;

PathSegment

One segment of an issue path.

ts
PathSegment: unknown;

Props

The properties exposed under a validator's ~standard key.

ts
Props: unknown;

SuccessResult

A successful validation carrying the parsed output value.

ts
SuccessResult: unknown;

Types

The type-level input and output carried by a validator.

ts
Types: unknown;

Type Aliases

InferInput

Infer the input type of a Standard Schema validator.

ts
InferInput: NonNullable<Schema["~standard"]["types"]>["input"];

InferOutput

Infer the output type of a Standard Schema validator.

ts
InferOutput: NonNullable<Schema["~standard"]["types"]>["output"];

Result

The result of validating a value: either its output or a list of issues.

ts
Result: StandardSchemaV1.SuccessResult<Output> | StandardSchemaV1.FailureResult;

See Also

Released under the MIT License.