Skip to content

StandardSchemaV1

Interfaces

FailureResult

Defined in: packages/core/src/standard.ts:26

Properties

issues

readonly issues: readonly Issue[]

Defined in: packages/core/src/standard.ts:27


Issue

Defined in: packages/core/src/standard.ts:29

Properties

message

readonly message: string

Defined in: packages/core/src/standard.ts:30

path?

readonly optional path?: readonly (PropertyKey | PathSegment)[]

Defined in: packages/core/src/standard.ts:31


PathSegment

Defined in: packages/core/src/standard.ts:33

Properties

key

readonly key: PropertyKey

Defined in: packages/core/src/standard.ts:34


Props

Defined in: packages/core/src/standard.ts:11

Type Parameters

Input

Input = unknown

Output

Output = Input

Properties

types?

readonly optional types?: Types<Input, Output>

Defined in: packages/core/src/standard.ts:15

validate

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

Defined in: packages/core/src/standard.ts:14

Parameters
value

unknown

Returns

Result<Output> | Promise<Result<Output>>

vendor

readonly vendor: string

Defined in: packages/core/src/standard.ts:13

version

readonly version: 1

Defined in: packages/core/src/standard.ts:12


SuccessResult

Defined in: packages/core/src/standard.ts:22

Type Parameters

Output

Output

Properties

issues?

readonly optional issues?: undefined

Defined in: packages/core/src/standard.ts:24

value

readonly value: Output

Defined in: packages/core/src/standard.ts:23


Types

Defined in: packages/core/src/standard.ts:17

Type Parameters

Input

Input = unknown

Output

Output = Input

Properties

input

readonly input: Input

Defined in: packages/core/src/standard.ts:18

output

readonly output: Output

Defined in: packages/core/src/standard.ts:19

Type Aliases

InferInput

InferInput<S> = NonNullable<S["~standard"]["types"]>["input"]

Defined in: packages/core/src/standard.ts:36

Type Parameters

S

S extends StandardSchemaV1


InferOutput

InferOutput<S> = NonNullable<S["~standard"]["types"]>["output"]

Defined in: packages/core/src/standard.ts:39

Type Parameters

S

S extends StandardSchemaV1


Result

Result<Output> = SuccessResult<Output> | FailureResult

Defined in: packages/core/src/standard.ts:21

Type Parameters

Output

Output