Class Model

Model stream implementation

Hierarchy

  • Stream
    • Model

Constructors

constructor

Properties

state$ MODEL STREAM_TYPE_ID STREAM_TYPE_NAME VERSION

Accessors

allCommitIds anchorCommitIds api commitId content id isReadOnly metadata state tip

Methods

makeReadOnly requestAnchor sync assertComplete assertRelationsValid assertVersionValid create load

Constructors

constructor

  • Parameters

    • state$: RunningStateLike
    • api: StreamReaderWriter

    Returns Model

Properties

Protected Readonly state$

state$: RunningStateLike

Static Readonly MODEL

MODEL: StreamID = ...

Static STREAM_TYPE_ID

STREAM_TYPE_ID: number = 2

Static STREAM_TYPE_NAME

STREAM_TYPE_NAME: string = 'model'

Static Readonly VERSION

VERSION: "2.0" = '2.0'

Accessors

allCommitIds

  • get allCommitIds(): CommitID[]

  • Returns CommitID[]

anchorCommitIds

  • get anchorCommitIds(): CommitID[]

  • Returns CommitID[]

api

  • get api(): StreamReaderWriter

  • Returns StreamReaderWriter

commitId

  • get commitId(): CommitID

  • Returns CommitID

content

  • get content(): MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> | MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf>

  • Returns MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> | MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf>

id

  • get id(): StreamID

  • Returns StreamID

isReadOnly

metadata

  • get metadata(): MapIn<{ controller: RefinementCodec<TrivialCodec<string>, string & WithOpaque<"DIDString">>; model: Type<StreamID, Uint8Array, Uint8Array> }, $TypeOf>

  • Returns MapIn<{ controller: RefinementCodec<TrivialCodec<string>, string & WithOpaque<"DIDString">>; model: Type<StreamID, Uint8Array, Uint8Array> }, $TypeOf>

state

  • get state(): StreamState<StreamMetadata>

  • Returns StreamState<StreamMetadata>

tip

  • get tip(): CID<unknown, number, number, Version>

  • Returns CID<unknown, number, number, Version>

Methods

makeReadOnly

  • Makes this document read-only. After this has been called any future attempts to call mutation methods on the instance will throw.

    Returns void

requestAnchor

  • Returns Promise<AnchorStatus>

sync

  • Parameters

    • Optional opts: LoadOpts

    Returns Promise<void>

Static assertComplete

  • Asserts that all the required fields for the Model are set, and throws an error if not.

    Parameters

    • content: MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> | MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf>
    • Optional _streamId: string | StreamID | CommitID

    Returns void

Static assertRelationsValid

  • Asserts that the relations properties of the given ModelDefinition are well formed, and throws an error if not.

    Parameters

    • content: MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> | MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf>

    Returns void

Static assertVersionValid

  • Asserts that the version of the model definition is supported.

    Parameters

    • content: MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> | MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf>

      Model definition object

    • satisfies: ValidVersionSatisfies = 'minor'

      Version range to satisfy

    Returns void

Static create

  • Creates a Model.

    Parameters

    • ceramic: StreamWriter

      Interface for writing models to ceramic network

    • content: MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"1.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>]>]>>> }>, $TypeOf> | MapIn<RequiredProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf> & MapIn<OptionalProps<{ accountRelation: UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"list"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"single"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"none"> }>>, ExactCodec<TypeCodec<{ fields: Codec<string[], string[], unknown> & {}; type: LiteralCodec<"set"> }>>]>; description: OptionalCodec<TrivialCodec<string>>; immutableFields: OptionalCodec<Codec<string[], string[], unknown> & {}>; implements: Codec<string[], string[], unknown> & {}; interface: TrivialCodec<boolean>; name: TrivialCodec<string>; relations: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"account"> }>>, ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; type: LiteralCodec<"document"> }>>]>>>; schema: Type<Object<any>, Object<any>, unknown>; version: LiteralCodec<"2.0">; views: OptionalCodec<NonEnumerableRecordCodec<TrivialCodec<string>, UnionCodec<[UnionCodec<[ExactCodec<TypeCodec<{ type: LiteralCodec<"documentAccount"> }>>, ExactCodec<TypeCodec<{ type: LiteralCodec<"documentVersion"> }>>]>, UnionCodec<[ExactCodec<TypeCodec<{ model: UnionCodec<[RefinementCodec<TrivialCodec<string>, string>, TrivialCodec<null>]>; property: TrivialCodec<string>; type: LiteralCodec<"relationDocument"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationCountFrom"> }>>, ExactCodec<TypeCodec<{ model: RefinementCodec<TrivialCodec<string>, string>; property: TrivialCodec<string>; type: LiteralCodec<"relationSetFrom"> }>>]>]>>> }>, $TypeOf>

      contents of the model to create

    • Optional metadata: ModelMetadataArgs

    Returns Promise<Model>

Static load

  • Loads a Model from a given StreamID

    Parameters

    • ceramic: StreamReader

      Interface for reading streams from ceramic network

    • streamId: string | StreamID | CommitID

      StreamID to load. Must correspond to a Model

    • opts: LoadOpts = {}

      Additional options

    Returns Promise<Model>

Settings

Member Visibility

Theme