GitHub

Reference core

types

interface 1 type 1
interface Interfaces 1
interface src/index.ts · L21

# StandardSchemaV1

Subset of the Standard Schema v1 type surface that Kumiki depends on.

Standard Schema is a type contract, not a runtime dependency — the validator implementation is supplied by the consumer (Zod 3.24+, Valibot 1.x, ArkType 2.0+, Effect Schema 3.x, …).

Type Parameters

Input
Output

Members

\_input?
readonly optional _input?: Input
~standard
readonly ~standard: object readonly validate: (value) => StandardSchemaResult<Output> | Promise<StandardSchemaResult<Output>> readonly vendor: string readonly version: 1

###### validate

###### Parameters

###### value

unknown

###### Returns

StandardSchemaResult<Output> | Promise<StandardSchemaResult<Output>>

###### vendor

###### version

type Type Aliases 1

# StandardSchemaResult

StandardSchemaResult<Output> = { issues?: undefined; value: Output; } | { issues: ReadonlyArray<{ message: string; path?: ReadonlyArray<PropertyKey>; }>; }

Result from a Standard Schema validator's validate() call.

Type Parameters

Output