Interface StringSchema<O, I>

Type Parameters

O extends string
I = unknown

Hierarchy

Schema<O, I>
- StringSchema

Index

Methods

and array brand default endsWith from is nullable optional or read refine startsWith

Methods

and

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

endsWith

endsWith<Suffix>(suffix): StringSchema<O & `${string}${Suffix}`, I>
Type Parameters
- Suffix extends string
Parameters
- suffix: Suffix
Returns StringSchema<O & `${string}${Suffix}`, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:149

from

from(value): O
Parameters
- value: I
Returns O
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 O
Parameters
- value: unknown
Returns value is O
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<null | O, I>
Returns Schema<null | O, I>
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<undefined | O, I>
Returns Schema<undefined | O, I>
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<O | T, I>
Type Parameters
- T
Parameters
- other: Reader<T, I, Failure>
Returns Schema<O | T, I>
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): Result<O, Failure>
Parameters
- input: I
Returns Result<O, Failure>
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): StringSchema<O & T, I>
Type Parameters
- T
Parameters
- schema: Reader<T, O, Failure>
Returns StringSchema<O & T, I>
Overrides Schema.refine
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:150

startsWith

startsWith<Prefix>(prefix): StringSchema<O & `${Prefix}${string}`, I>
Type Parameters
- Prefix extends string
Parameters
- prefix: Prefix
Returns StringSchema<O & `${Prefix}${string}`, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:148

Generated using TypeDoc