Class ModelInstanceDocument<T>

ModelInstanceDocument stream implementation

Type Parameters

T = Record<string, any>

Hierarchy

Stream
- ModelInstanceDocument

Index

Constructors

constructor

new ModelInstanceDocument<T>(state$: RunningStateLike, _context: Context): ModelInstanceDocument<T>
Type Parameters
- T = Record<string, any>
Parameters
- state$: RunningStateLike
- _context: Context
Returns ModelInstanceDocument<T>
Inherited from Stream.constructor
- Defined in packages/common/lib/stream.d.ts:111

Properties

`Protected` `Readonly` state$

state$: RunningStateLike

`Static` STREAM_TYPE_ID

STREAM_TYPE_ID: number = 3

`Static` STREAM_TYPE_NAME

STREAM_TYPE_NAME: string = 'MID'

Accessors

allCommitIds

get allCommitIds(): CommitID[]
Returns CommitID[]
Inherited from Stream.allCommitIds
- Defined in packages/common/lib/stream.d.ts:118

anchorCommitIds

get anchorCommitIds(): CommitID[]
Returns CommitID[]
Inherited from Stream.anchorCommitIds
- Defined in packages/common/lib/stream.d.ts:119

api

get api(): CeramicApi
Returns CeramicApi
Inherited from Stream.api
- Defined in packages/common/lib/stream.d.ts:113

commitId

get commitId(): CommitID
Returns CommitID
Inherited from Stream.commitId
- Defined in packages/common/lib/stream.d.ts:117

content

get content(): T
Returns T
Overrides Stream.content
- Defined in packages/stream-model-instance/src/model-instance-document.ts:103

id

get id(): StreamID
Returns StreamID
Inherited from Stream.id
- Defined in packages/common/lib/stream.d.ts:112

isReadOnly

get isReadOnly(): boolean
Returns boolean
Overrides Stream.isReadOnly
- Defined in packages/stream-model-instance/src/model-instance-document.ts:225

metadata

get metadata(): ModelInstanceDocumentMetadata
Returns ModelInstanceDocumentMetadata
Overrides Stream.metadata
- Defined in packages/stream-model-instance/src/model-instance-document.ts:107

state

get state(): StreamState
Returns StreamState
Inherited from Stream.state
- Defined in packages/common/lib/stream.d.ts:120

tip

get tip(): CID
Returns CID
Inherited from Stream.tip
- Defined in packages/common/lib/stream.d.ts:116

Methods

makeReadOnly

makeReadOnly(): void
Makes this document read-only. After this has been called any future attempts to call mutation methods on the instance will throw.

Returns void
Overrides Stream.makeReadOnly
- Defined in packages/stream-model-instance/src/model-instance-document.ts:218

patch

patch(jsonPatch: Operation[], opts?: UpdateOpts): Promise<void>
Update the contents of an existing Model Instance Document based on a JSON-patch diff from the existing contents to the desired new contents
Parameters
- jsonPatch: Operation[]
  
  JSON patch diff of document contents
- opts: UpdateOpts = {}
  
  Additional options
Returns Promise<void>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:202

replace

replace(content: T, opts?: UpdateOpts): Promise<void>
Update an existing Model Instance Document by replacing its content
Parameters
- content: T
  
  New content to replace old content
- opts: UpdateOpts = {}
  
  Additional options
Returns Promise<void>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:188

requestAnchor

requestAnchor(): Promise<AnchorStatus>
Returns Promise<AnchorStatus>
Inherited from Stream.requestAnchor
- Defined in packages/common/lib/stream.d.ts:122

sync

sync(opts?: LoadOpts): Promise<void>
Parameters
- Optional opts: LoadOpts
Returns Promise<void>
Inherited from Stream.sync
- Defined in packages/common/lib/stream.d.ts:121

`Static` create

create<T>(ceramic: CeramicApi, content: T, metadata: ModelInstanceDocumentMetadataArgs, opts?: CreateOpts): Promise<ModelInstanceDocument<T>>
Creates a Model Instance Document.
Type Parameters
- T
Parameters
- ceramic: CeramicApi
  
  Instance of CeramicAPI used to communicate with the Ceramic network
- content: T
  
  Genesis contents. If 'null', then no signature is required to make the genesis commit
- metadata: ModelInstanceDocumentMetadataArgs
  
  Genesis metadata, including the model that this document belongs to
- opts: CreateOpts = {}
  
  Additional options
Returns Promise<ModelInstanceDocument<T>>
Overrides Stream.create
- Defined in packages/stream-model-instance/src/model-instance-document.ts:119

`Static` load

load<T>(ceramic: CeramicApi, streamId: string | StreamID | CommitID, opts?: LoadOpts): Promise<ModelInstanceDocument<T>>
Loads a Model Instance Document from a given StreamID
Type Parameters
- T
Parameters
- ceramic: CeramicApi
  
  Instance of CeramicAPI used to communicate with the Ceramic network
- streamId: string | StreamID | CommitID
  
  StreamID to load. Must correspond to a ModelInstanceDocument
- opts: LoadOpts = {}
  
  Additional options
Returns Promise<ModelInstanceDocument<T>>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:165

`Static` single

single<T>(ceramic: CeramicApi, metadata: ModelInstanceDocumentMetadataArgs, opts?: CreateOpts): Promise<ModelInstanceDocument<T>>
Creates a deterministic ModelInstanceDocument with a 'single' accountRelation.
Type Parameters
- T
Parameters
- ceramic: CeramicApi
  
  Instance of CeramicAPI used to communicate with the Ceramic network
- metadata: ModelInstanceDocumentMetadataArgs
  
  Genesis metadata
- opts: CreateOpts = {}
  
  Additional options
Returns Promise<ModelInstanceDocument<T>>
- Defined in packages/stream-model-instance/src/model-instance-document.ts:142

Class ModelInstanceDocument<T>

Type Parameters

T = Record<string, any>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T = Record<string, any>

Parameters

state$: RunningStateLike

_context: Context

Returns ModelInstanceDocument<T>

Properties

Protected Readonly state$

Static STREAM_TYPE_ID

Static STREAM_TYPE_NAME

Accessors

allCommitIds

Returns CommitID[]

anchorCommitIds

Returns CommitID[]

api

Returns CeramicApi

commitId

Returns CommitID

content

Returns T

id

Returns StreamID

isReadOnly

Returns boolean

metadata

Returns ModelInstanceDocumentMetadata

state

Returns StreamState

tip

Returns CID

Methods

makeReadOnly

Returns void

patch

Parameters

jsonPatch: Operation[]

opts: UpdateOpts = {}

Returns Promise<void>

replace

Parameters

content: T

opts: UpdateOpts = {}

Returns Promise<void>

requestAnchor

Returns Promise<AnchorStatus>

sync

Parameters

Optional opts: LoadOpts

Returns Promise<void>

Static create

Type Parameters

T

Parameters

ceramic: CeramicApi

content: T

metadata: ModelInstanceDocumentMetadataArgs

opts: CreateOpts = {}

Returns Promise<ModelInstanceDocument<T>>

Static load

Type Parameters

T

Parameters

ceramic: CeramicApi

streamId: string | StreamID | CommitID

opts: LoadOpts = {}

Returns Promise<ModelInstanceDocument<T>>

Static single

Type Parameters

`Protected` `Readonly` state$

`Static` STREAM_TYPE_ID

`Static` STREAM_TYPE_NAME

`Optional` opts: LoadOpts

`Static` create

`Static` load

`Static` single