Interface StructSchema<U, I>

In IPLD Schema types may have different [representation]s, this interface represents all the types that have a map representation and defines extensions relevant to such types. [representation]: https://ipld.io/docs/schemas/features/representation-strategies/

Type Parameters

U extends {
[key: string]: Schema.Reader;
} = {}
I extends unknown = unknown

Hierarchy

Schema.MapRepresentation<Schema.InferStruct, I>
- StructSchema

Index

Properties

shape

Methods

and array brand create default extend from is nullable optional or partial read refine

Properties

shape

shape: U

Methods

and

and<T>(other): Schema.Schema<Pick<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
}, RequiredKeys<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
}>> & Partial<Pick<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
}, OptionalKeys<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
}>>> & T, I>
Type Parameters
- T
Parameters
- other: Schema.Reader<T, I, Schema.Error>
Returns Schema.Schema<Pick<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
}, RequiredKeys<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
}>> & Partial<Pick<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
}, OptionalKeys<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
}>>> & T, I>
Inherited from MapRepresentation.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<Schema.InferStruct[], I>
Returns Schema.Schema<Schema.InferStruct[], I>
Inherited from MapRepresentation.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<Schema.InferStruct, K>, I>
Type Parameters
- K extends string
Parameters
- Optional kind: K
Returns Schema.Schema<Schema.Branded<Schema.InferStruct, K>, I>
Inherited from MapRepresentation.brand
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:15

create

create(input): Schema.InferStruct
Parameters
- input: Schema.MarkEmptyOptional<Schema.InferStructSource>
Returns Schema.InferStruct
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:60

default

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

extend

extend<E>(extension): Schema.StructSchema
Type Parameters
- E extends {
 [key: string]: Schema.Reader;
 }
Parameters
- extension: E
Returns Schema.StructSchema
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:61

from

from(value): Schema.InferStruct
Parameters
- value: I
Returns Schema.InferStruct
Inherited from MapRepresentation.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 Schema.InferStruct
Parameters
- value: unknown
Returns value is Schema.InferStruct
Inherited from MapRepresentation.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 | Schema.InferStruct, I>
Returns Schema.Schema<null | Schema.InferStruct, I>
Inherited from MapRepresentation.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 | Schema.InferStruct, I>
Returns Schema.Schema<undefined | Schema.InferStruct, I>
Inherited from MapRepresentation.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<Schema.InferStruct | T, I>
Type Parameters
- T
Parameters
- other: Schema.Reader<T, I, Schema.Error>
Returns Schema.Schema<Schema.InferStruct | T, I>
Inherited from MapRepresentation.or
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:12

partial

partial(): Schema.MapRepresentation<Partial<Schema.InferStruct>, I> & Schema.StructSchema<{}, unknown>
Returns equivalent schema in which all of the fields are optional.

Returns Schema.MapRepresentation<Partial<Schema.InferStruct>, I> & Schema.StructSchema<{}, unknown>
Overrides MapRepresentation.partial
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:64

read

read(input): Schema.Result<Schema.InferStruct, Schema.Error>
Parameters
- input: I
Returns Schema.Result<Schema.InferStruct, Schema.Error>
Inherited from MapRepresentation.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 Schema.InferStruct
Parameters
- schema: Schema.Reader<Pick<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
 }, RequiredKeys<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
 }>> & Partial<Pick<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
 }, OptionalKeys<{
 [K in string | number | symbol]: Schema.Infer<U[K]>
 }>>> & T, Schema.InferStruct, Schema.Error>
Returns Schema.Schema<T, I>
Inherited from MapRepresentation.refine
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:14

Interface StructSchema<U, I>

Type Parameters

U extends { [key: string]: Schema.Reader; } = {}

I extends unknown = unknown

Hierarchy

Index

Properties

Methods

Properties

shape

Methods

and

Type Parameters

T

Parameters

other: Schema.Reader<T, I, Schema.Error>

array

Returns Schema.Schema<Schema.InferStruct<U>[], I>

brand

Type Parameters

K extends string

Parameters

Optional kind: K

Returns Schema.Schema<Schema.Branded<Schema.InferStruct<U>, K>, I>

create

Parameters

input: Schema.MarkEmptyOptional<Schema.InferStructSource<U>>

Returns Schema.InferStruct<U>

default

Parameters

value: Exclude<Schema.InferStruct<U>, undefined>

Returns Schema.DefaultSchema<Exclude<Schema.InferStruct<U>, undefined>, I>

extend

Type Parameters

E extends { [key: string]: Schema.Reader; }

Parameters

extension: E

Returns Schema.StructSchema<U & E, I>

from

Parameters

value: I

Returns Schema.InferStruct<U>

is

Parameters

value: unknown

Returns value is Schema.InferStruct<U>

nullable

Returns Schema.Schema<null | Schema.InferStruct<U>, I>

optional

Returns Schema.Schema<undefined | Schema.InferStruct<U>, I>

or

Type Parameters

T

Parameters

other: Schema.Reader<T, I, Schema.Error>

Returns Schema.Schema<Schema.InferStruct<U> | T, I>

partial

Returns Schema.MapRepresentation<Partial<Schema.InferStruct<U>>, I> & Schema.StructSchema<{}, unknown>

read

Parameters

input: I

Returns Schema.Result<Schema.InferStruct<U>, Schema.Error>

refine

Type Parameters

T extends Schema.InferStruct<U>

Parameters

Returns Schema.Schema<T, I>

Settings

Member Visibility

Theme

On This Page

U extends {
[key: string]: Schema.Reader;
} = {}

`Optional` kind: K

E extends {
[key: string]: Schema.Reader;
}