Interface Props<Input, Output>

The Standard Schema properties interface.

interface Props<Input = unknown, Output = Input> {
    types?: Types<Input, Output>;
    validate: (
        value: unknown,
        options?: StandardSchemaV1.Options,
    ) =>
        | StandardSchemaV1.Result<Output>
        | Promise<StandardSchemaV1.Result<Output>>;
    vendor: string;
    version: 1;
}

Type Parameters

Input = unknown
Output = Input

Hierarchy

Props<Input, Output>
- Props

Index

Properties

types? validate vendor version

Properties

`Optional` `Readonly`types

types?: Types<Input, Output>

Inferred types associated with the schema.

`Readonly`validate

validate: (
    value: unknown,
    options?: StandardSchemaV1.Options,
) =>
    | StandardSchemaV1.Result<Output>
    | Promise<StandardSchemaV1.Result<Output>>

Validates unknown input values.

`Readonly`vendor

vendor: string

The vendor name of the schema library.

`Readonly`version

version: 1

The version number of the standard.