Interface DictionarySchema<V, K, 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

V
K extends string
I = unknown

Hierarchy

Schema.MapRepresentation<Schema.Dictionary<K, V>, I>
- DictionarySchema

Index

Properties

key value

Methods

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

Properties

key

key: Schema.Reader<K, string, Schema.Error>

value

value: Schema.Reader<V, I, Schema.Error>

Methods

and

and<T>(other): Schema.Schema<Schema.Dictionary<K, V> & T, I>
Type Parameters
- T
Parameters
- other: Schema.Reader<T, I, Schema.Error>
Returns Schema.Schema<Schema.Dictionary<K, V> & 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.Dictionary<K, V>[], I>
Returns Schema.Schema<Schema.Dictionary<K, V>[], 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.Dictionary<K, V>, K>, I>
Type Parameters
- K extends string
Parameters
- Optional kind: K
Returns Schema.Schema<Schema.Branded<Schema.Dictionary<K, V>, 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

default

default(value): Schema.DefaultSchema<Exclude<Schema.Dictionary<K, V>, undefined>, I>
Parameters
- value: Exclude<Schema.Dictionary<K, V>, undefined>
Returns Schema.DefaultSchema<Exclude<Schema.Dictionary<K, V>, 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

from

from(value): Schema.Dictionary<K, V>
Parameters
- value: I
Returns Schema.Dictionary<K, V>
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.Dictionary<K, V>
Parameters
- value: unknown
Returns value is Schema.Dictionary<K, V>
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.Dictionary<K, V>, I>
Returns Schema.Schema<null | Schema.Dictionary<K, V>, 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.Dictionary<K, V>, I>
Returns Schema.Schema<undefined | Schema.Dictionary<K, V>, 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.Dictionary<K, V> | T, I>
Type Parameters
- T
Parameters
- other: Schema.Reader<T, I, Schema.Error>
Returns Schema.Schema<Schema.Dictionary<K, V> | 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.DictionarySchema<undefined | V, K, I>
Returns equivalent schema in which all of the fields are optional.

Returns Schema.DictionarySchema<undefined | V, K, I>
Overrides MapRepresentation.partial
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:42

read

read(input): Schema.Result<Schema.Dictionary<K, V>, Schema.Error>
Parameters
- input: I
Returns Schema.Result<Schema.Dictionary<K, V>, 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.Dictionary<K, V>
Parameters
- schema: Schema.Reader<Schema.Dictionary<K, V> & T, Schema.Dictionary<K, V>, 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 DictionarySchema<V, K, I>

Type Parameters

V

K extends string

I = unknown

Hierarchy

Index

Properties

Methods

Properties

key

value

Methods

and

Type Parameters

T

Parameters

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

Returns Schema.Schema<Schema.Dictionary<K, V> & T, I>

array

Returns Schema.Schema<Schema.Dictionary<K, V>[], I>

brand

Type Parameters

K extends string

Parameters

Optional kind: K

Returns Schema.Schema<Schema.Branded<Schema.Dictionary<K, V>, K>, I>

default

Parameters

value: Exclude<Schema.Dictionary<K, V>, undefined>

Returns Schema.DefaultSchema<Exclude<Schema.Dictionary<K, V>, undefined>, I>

from

Parameters

value: I

Returns Schema.Dictionary<K, V>

is

Parameters

value: unknown

Returns value is Schema.Dictionary<K, V>

nullable

Returns Schema.Schema<null | Schema.Dictionary<K, V>, I>

optional

Returns Schema.Schema<undefined | Schema.Dictionary<K, V>, I>

or

Type Parameters

T

Parameters

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

Returns Schema.Schema<Schema.Dictionary<K, V> | T, I>

partial

Returns Schema.DictionarySchema<undefined | V, K, I>

read

Parameters

input: I

Returns Schema.Result<Schema.Dictionary<K, V>, Schema.Error>

refine

Type Parameters

T extends Schema.Dictionary<K, V>

Parameters

schema: Schema.Reader<Schema.Dictionary<K, V> & T, Schema.Dictionary<K, V>, Schema.Error>

Returns Schema.Schema<T, I>

Settings

Member Visibility

Theme

On This Page

`Optional` kind: K