API reference / @chanx-js/server / core / StandardSchemaV1

Interface: StandardSchemaV1<Input, Output>

Defined in: packages/server/src/standard-schema.ts:4

Type Parameters

Type Parameter	Default type
Input	unknown
Output	Input

Properties

~standard

readonly ~standard: object;

Defined in: packages/server/src/standard-schema.ts:5

jsonSchema?

readonly optional jsonSchema?: object;

Standard JSON Schema (https://standardschema.dev/json-schema), where the library has it.

jsonSchema.input

readonly input: (options) => JsonSchema;

Parameters

Parameter	Type
options	{ target: string; }
options.target	string

Returns

JsonSchema

jsonSchema.output

readonly output: (options) => JsonSchema;

Parameters

Parameter	Type
options	{ target: string; }
options.target	string

Returns

JsonSchema

types?

readonly optional types?: object;

types.input

readonly input: Input;

types.output

readonly output: Output;

validate

readonly validate: (value) => SchemaResult<Output> | Promise<SchemaResult<Output>>;

Parameters

Parameter	Type
value	unknown

Returns

SchemaResult<Output> | Promise<SchemaResult<Output>>

vendor

readonly vendor: string;

version

readonly version: 1;