Interface StreamHandler<T>

Describes stream type handler functionality

Type Parameters

T extends Stream

Hierarchy

StreamHandler

Index

Properties

name stream_constructor type

Methods

Properties

name

name: string

The string name of the streamtype

stream_constructor

stream_constructor: StreamConstructor<T>

The constructor used to instantiate an instance of the handled streamtype.

type

type: number

The ID number of the streamtype. This is specified by the table within CIP-59.

Methods

applyCommit

applyCommit(commitData: CommitData, api: StreamReaderWriter, state?: StreamState<StreamMetadata>): Promise<StreamState<StreamMetadata>>
Applies commit to the stream (init|data|time) and returns the new StreamState. StreamHandler implementations of applyCommit are allowed to modify the input state, it is up to callers to clone the input state before calling into applyCommit if they don't want the input state modified.
Parameters
- commitData: CommitData
  
  Commit data
- api: StreamReaderWriter
  
  Interface for reading from and writing streams to ceramic network
- Optional state: StreamState<StreamMetadata>
  
  The existing state to apply the commit to.
Returns Promise<StreamState<StreamMetadata>>
- Defined in packages/common/src/stream.ts:337