Class ModelInstanceDocumentHandler

ModelInstanceDocument stream handler implementation

Hierarchy

ModelInstanceDocumentHandler

Implements

StreamHandler<ModelInstanceDocument>

Index

Constructors

Accessors

name stream_constructor type

Methods

_validateHeader applyCommit

Constructors

constructor

new ModelInstanceDocumentHandler(): ModelInstanceDocumentHandler
Returns ModelInstanceDocumentHandler
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:37

Accessors

name

get name(): string
Returns string
Implementation of StreamHandler.name
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:45

stream_constructor

get stream_constructor(): StreamConstructor<ModelInstanceDocument<Record<string, any>>>
Returns StreamConstructor<ModelInstanceDocument<Record<string, any>>>
Implementation of StreamHandler.stream_constructor
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:49

type

get type(): number
Returns number
Implementation of StreamHandler.type
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:41

Methods

_validateHeader

_validateHeader(model: Model, header: ModelInstanceDocumentHeader): Promise<void>
Validates the ModelInstanceDocument header against the Model definition.
Parameters
- model: Model
  
  The model that this ModelInstanceDocument belongs to
- header: ModelInstanceDocumentHeader
  
  the header to validate
Returns Promise<void>
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:216

applyCommit

applyCommit(commitData: CommitData, context: Context, state?: StreamState): Promise<StreamState>
Applies commit (genesis|signed|anchor)
Parameters
- commitData: CommitData
  
  Commit (with JWS envelope or anchor proof, if available and extracted before application)
- context: Context
  
  Ceramic context
- Optional state: StreamState
  
  Document state
Returns Promise<StreamState>
Implementation of StreamHandler.applyCommit
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:59