Interface Props<Input, Output>

The Standard Schema properties interface.

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

Type Parameters

Input = unknown
Output = Input

Hierarchy (View Summary)

Props<Input, Output>
- Props
  - StandardSchemaWithJSONProps

Index

Properties

version vendor types? validate

Properties

`Readonly`version

version: 1

The version number of the standard.

`Readonly`vendor

vendor: string

The vendor name of the schema library.

`Optional` `Readonly`types

types?: Types<Input, Output>

Inferred types associated with the schema.

`Readonly`validate

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

Validates unknown input values.