@pcvl/schema

Appearance

@pcvl/schema / StandardSchemaProps

Type Alias: StandardSchemaProps<Input, Output> ​

ts
type StandardSchemaProps<Input, Output> = Omit<StandardSchemaV1.Props<Input, Output>, "vendor" | "validate"> & object;

Defined in: standardSchema.ts:24

The Standard Schema properties every @pcvl/schema schema reports: vendor is exactly '@pcvl/schema', and validate returns a Result synchronously.

Type Declaration ​

validate ​

ts
readonly validate: (value) => Result<Output>;

Parameters ​

value ​

unknown

Returns ​

Result<Output>

vendor ​

ts
readonly vendor: typeof VENDOR;

Type Parameters ​

Input ​

Input = unknown

Output ​

Output = Input

Example ​

ts
import { pvl, type StandardSchemaProps } from '@pcvl/schema';

const props: StandardSchemaProps<string, string> = pvl.string()['~standard'];
props.vendor; // '@pcvl/schema'
props.validate('hello'); // { value: 'hello' }