Class ModelInstanceDocumentHandler

ModelInstanceDocument stream handler implementation

Hierarchy

ModelInstanceDocumentHandler

Implements

StreamHandler<ModelInstanceDocument>

Index

Constructors

constructor

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

Accessors

name

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

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:64

type

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

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:354

_validateLockedFieldsUpdate

_validateLockedFieldsUpdate(model: Model, payload: Payload): Promise<void>
Helper function to validate if immutable fields are being mutated
Parameters
- model: Model
- payload: Payload
Returns Promise<void>
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:373

_validateRelationsContent

_validateRelationsContent(ceramic: StreamReader, model: Model, content: any): Promise<void>
Parameters
- ceramic: StreamReader
- model: Model
- content: any
Returns Promise<void>
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:289

_validateUnique

_validateUnique(model: Model, metadata: ModelInstanceDocumentMetadata, content: null | Record<string, unknown>): Promise<void>
Parameters
- model: Model
- metadata: ModelInstanceDocumentMetadata
- content: null | Record<string, unknown>
Returns Promise<void>
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:395

applyCommit

applyCommit(commitData: CommitData, context: StreamReaderWriter, state?: StreamState<ModelInstanceDocumentStateMetadata>): 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<ModelInstanceDocumentStateMetadata>
  
  Document state
Returns Promise<StreamState<StreamMetadata>>
Implementation of StreamHandler.applyCommit
- Defined in packages/stream-model-instance-handler/src/model-instance-document-handler.ts:74

Class ModelInstanceDocumentHandler

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns ModelInstanceDocumentHandler

Accessors

name

Returns string

stream_constructor

Returns StreamConstructor<ModelInstanceDocument<Record<string, any>>>

type

Returns number

Methods

_validateHeader

Parameters

model: Model

header: ModelInstanceDocumentHeader

Returns Promise<void>

_validateLockedFieldsUpdate

Parameters

model: Model

payload: Payload

Returns Promise<void>

_validateRelationsContent

Parameters

ceramic: StreamReader

model: Model

content: any

Returns Promise<void>

_validateUnique

Parameters

model: Model

metadata: ModelInstanceDocumentMetadata

content: null | Record<string, unknown>

Returns Promise<void>

applyCommit

Parameters

commitData: CommitData

context: StreamReaderWriter

Optional state: StreamState<ModelInstanceDocumentStateMetadata>

Returns Promise<StreamState<StreamMetadata>>

Settings

Member Visibility

Theme

`Optional` state: StreamState<ModelInstanceDocumentStateMetadata>