Interface Schema<O, I>

Type Parameters

O extends unknown = unknown
I extends unknown = unknown

Hierarchy

Schema.Reader<O, I>
- Schema

Implemented by

Schema.API

Index

Methods

and array brand default from is nullable optional or read refine

Methods

and

and<T>(other): Schema.Schema<O & T, I>
Type Parameters
- T
Parameters
- other: Schema.Reader<T, I, Schema.Error>
Returns Schema.Schema<O & T, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:13

array

array(): Schema.Schema<O[], I>
Returns Schema.Schema<O[], I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:10

brand

brand<K>(kind?): Schema.Schema<Schema.Branded<O, K>, I>
Type Parameters
- K extends string
Parameters
- Optional kind: K
Returns Schema.Schema<Schema.Branded<O, K>, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:15

default

default(value): Schema.DefaultSchema<Exclude<O, undefined>, I>
Parameters
- value: Exclude<O, undefined>
Returns Schema.DefaultSchema<Exclude<O, undefined>, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:11

from

from(value): O
Parameters
- value: I
Returns O
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:17

is

is(value): value is O
Parameters
- value: unknown
Returns value is O
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:16

nullable

nullable(): Schema.Schema<null | O, I>
Returns Schema.Schema<null | O, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:9

optional

optional(): Schema.Schema<undefined | O, I>
Returns Schema.Schema<undefined | O, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:8

or

or<T>(other): Schema.Schema<O | T, I>
Type Parameters
- T
Parameters
- other: Schema.Reader<T, I, Schema.Error>
Returns Schema.Schema<O | T, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:12

read

read(input): Schema.Result<O, Schema.Error>
Parameters
- input: I
Returns Schema.Result<O, Schema.Error>
Inherited from Reader.read
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:3

refine

refine<T>(schema): Schema.Schema<T, I>
Type Parameters
- T extends unknown
Parameters
- schema: Schema.Reader<O & T, O, Schema.Error>
Returns Schema.Schema<T, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:14

Generated using TypeDoc