Class TileDocumentHandler

TileDocument stream handler implementation

Hierarchy

TileDocumentHandler

Implements

StreamHandler<TileDocument>

Index

Constructors

Accessors

name stream_constructor type

Methods

Constructors

constructor

new TileDocumentHandler(): TileDocumentHandler
Returns TileDocumentHandler
- Defined in packages/stream-tile-handler/src/tile-document-handler.ts:38

Accessors

name

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

stream_constructor

get stream_constructor(): StreamConstructor<TileDocument<Record<string, any>>>
Returns StreamConstructor<TileDocument<Record<string, any>>>
Implementation of StreamHandler.stream_constructor
- Defined in packages/stream-tile-handler/src/tile-document-handler.ts:50

type

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

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 or write to ceramic network
- Optional state: StreamState<StreamMetadata>
  
  Document state
Returns Promise<StreamState<StreamMetadata>>
Implementation of StreamHandler.applyCommit
- Defined in packages/stream-tile-handler/src/tile-document-handler.ts:60