Class API<T, I, Settings>

Abstract

Implements

Type Parameters

T = unknown
I = unknown
Settings = void

Hierarchy

API

Implements

Schema.Schema<T, I>

Index

Constructors

Properties

Methods

and array brand default from is nullable optional or read readWith refine toString

Constructors

constructor

new API<T, I, Settings>(settings): Schema.API<T, I, Settings>
Type Parameters
- T = unknown
- I = unknown
- Settings = void
Parameters
- settings: Settings
Returns Schema.API<T, I, Settings>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/schema.d.ts:14

Properties

`Protected` settings

settings: Settings

Methods

and

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

array

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

brand

brand<Kind>(kind?): Schema.Schema<Schema.Branded<T, Kind>, I>
Type Parameters
- Kind extends string
Parameters
- Optional kind: Kind
Returns Schema.Schema<Schema.Branded<T, Kind>, I>
Implementation of Schema.brand
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/schema.d.ts:75

default

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

from

from(value): T
Parameters
- value: unknown
Returns T
Implementation of Schema.from
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/schema.d.ts:39

is

is(value): value is T
Parameters
- value: unknown
Returns value is T
Implementation of Schema.is
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/schema.d.ts:34

nullable

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

optional

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

or

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

read

read(input): Schema.ReadResult<T, Schema.Error>
Parameters
- input: I
Returns Schema.ReadResult<T, Schema.Error>
Implementation of Schema.read
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/schema.d.ts:29

readWith

readWith(input, settings): Schema.ReadResult<T, Schema.Error>
Parameters
- input: I
- settings: Settings
Returns Schema.ReadResult<T, Schema.Error>
Abstract
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/schema.d.ts:24

refine

refine<U_2>(schema): Schema.Schema<U_2, I>
Type Parameters
- U_2
Parameters
- schema: Schema.Reader<U_2, T, Schema.Error>
Returns Schema.Schema<U_2, I>
Implementation of Schema.refine
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/schema.d.ts:69

toString

toString(): string
Returns string
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/schema.d.ts:17

Generated using TypeDoc