Interface LiteralSchema<T, I>

Type Parameters

T extends string | number | boolean | null
I = unknown

Hierarchy

Schema.Schema<T>
- LiteralSchema

Index

Properties

Methods

and array brand default from is nullable optional or read refine

Properties

`Readonly` value

value: T

Methods

and

and<T>(other): Schema.Schema<T & T, unknown>
Type Parameters
- T
Parameters
- other: Schema.Reader<T, unknown, Schema.Error>
Returns Schema.Schema<T & T, unknown>
Inherited from Schema.and
- 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<T[], unknown>
Returns Schema.Schema<T[], unknown>
Inherited from Schema.array
- 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<T, K>, unknown>
Type Parameters
- K extends string
Parameters
- Optional kind: K
Returns Schema.Schema<Schema.Branded<T, K>, unknown>
Inherited from Schema.brand
- 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<T & Exclude<T, undefined>, I>
Parameters
- Optional value: T
Returns Schema.DefaultSchema<T & Exclude<T, undefined>, I>
Overrides Schema.default
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:48

from

from(value): T
Parameters
- value: unknown
Returns T
Inherited from Schema.from
- 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 T
Parameters
- value: unknown
Returns value is T
Inherited from Schema.is
- 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 | T, unknown>
Returns Schema.Schema<null | T, unknown>
Inherited from Schema.nullable
- 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 | T, unknown>
Returns Schema.Schema<undefined | T, unknown>
Inherited from Schema.optional
- 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<T | T, unknown>
Type Parameters
- T
Parameters
- other: Schema.Reader<T, unknown, Schema.Error>
Returns Schema.Schema<T | T, unknown>
Inherited from Schema.or
- 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<T, Schema.Error>
Parameters
- input: unknown
Returns Schema.Result<T, Schema.Error>
Inherited from Schema.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, unknown>
Type Parameters
- T extends null | string | number | boolean
Parameters
- schema: Schema.Reader<T & T, T, Schema.Error>
Returns Schema.Schema<T, unknown>
Inherited from Schema.refine
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:14

Generated using TypeDoc