Interface MapRepresentation<V, 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 extends Record<string, unknown>
I = unknown

Hierarchy

Space.Store.Schema.Schema<V, I>
- MapRepresentation
  - Space.Store.Schema.DictionarySchema
  - Space.Store.Schema.StructSchema

Index

Methods

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

Methods

and

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

from

from(value): V
Parameters
- value: I
Returns V
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 V
Parameters
- value: unknown
Returns value is V
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(): Space.Store.Schema.Schema<null | V, I>
Returns Space.Store.Schema.Schema<null | V, 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(): Space.Store.Schema.Schema<undefined | V, I>
Returns Space.Store.Schema.Schema<undefined | V, 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): Space.Store.Schema.Schema<V | T, I>
Type Parameters
- T
Parameters
- other: Space.Store.Schema.Reader<T, I, Space.Store.Schema.Error>
Returns Space.Store.Schema.Schema<V | 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

partial

partial(): Space.Store.Schema.MapRepresentation<Partial<V>, I>
Returns equivalent schema in which all of the fields are optional.

Returns Space.Store.Schema.MapRepresentation<Partial<V>, I>
- Defined in node_modules/.pnpm/@ucanto+core@10.0.1/node_modules/@ucanto/core/dist/src/schema/type.d.ts:37

read

read(input): Space.Store.Schema.Result<V, Space.Store.Schema.Error>
Parameters
- input: I
Returns Space.Store.Schema.Result<V, Space.Store.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): Space.Store.Schema.Schema<T, I>
Type Parameters
- T extends Record<string, unknown>
Parameters
- schema: Space.Store.Schema.Reader<V & T, V, Space.Store.Schema.Error>
Returns Space.Store.Schema.Schema<T, I>
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

Interface MapRepresentation<V, I>

Type Parameters

V extends Record<string, unknown>

I = unknown

Hierarchy

Index

Methods

Methods

and

Type Parameters

T

Parameters

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

Returns Space.Store.Schema.Schema<V & T, I>

array

Returns Space.Store.Schema.Schema<V[], I>

brand

Type Parameters

K extends string

Parameters

Optional kind: K

Returns Space.Store.Schema.Schema<Space.Store.Schema.Branded<V, K>, I>

default

Parameters

value: Exclude<V, undefined>

Returns Space.Store.Schema.DefaultSchema<Exclude<V, undefined>, I>

from

Parameters

value: I

Returns V

is

Parameters

value: unknown

Returns value is V

nullable

Returns Space.Store.Schema.Schema<null | V, I>

optional

Returns Space.Store.Schema.Schema<undefined | V, I>

or

Type Parameters

T

Parameters

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

Returns Space.Store.Schema.Schema<V | T, I>

partial

Returns Space.Store.Schema.MapRepresentation<Partial<V>, I>

read

Parameters

input: I

Returns Space.Store.Schema.Result<V, Space.Store.Schema.Error>

refine

Type Parameters

T extends Record<string, unknown>

Parameters

schema: Space.Store.Schema.Reader<V & T, V, Space.Store.Schema.Error>

Returns Space.Store.Schema.Schema<T, I>

Settings

Member Visibility

Theme

On This Page

`Optional` kind: K