Class ModelHandler

Model stream handler implementation

Hierarchy

ModelHandler

Implements

StreamHandler<Model>

Index

Constructors

Accessors

name stream_constructor type

Methods

Constructors

constructor

new ModelHandler(): ModelHandler
Returns ModelHandler
- Defined in packages/stream-model-handler/src/model-handler.ts:66

Accessors

name

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

stream_constructor

get stream_constructor(): StreamConstructor<Model>
Returns StreamConstructor<Model>
Implementation of StreamHandler.stream_constructor
- Defined in packages/stream-model-handler/src/model-handler.ts:62

type

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

Methods

applyCommit

applyCommit(commitData: CommitData, context: StreamReaderWriter, state?: StreamState<StreamMetadata>): Promise<StreamState<StreamMetadata>>
Applies commit (genesis|signed|anchor)
Parameters
- commitData: CommitData
  
  Commit (with JWS envelope or anchor proof, if available and extracted before application)
- context: StreamReaderWriter
  
  Interface to read and write data to ceramic network
- Optional state: StreamState<StreamMetadata>
  
  Document state
Returns Promise<StreamState<StreamMetadata>>
Implementation of StreamHandler.applyCommit
- Defined in packages/stream-model-handler/src/model-handler.ts:77