Interface StreamWriter

Hierarchy

IntoSigner
- StreamWriter
  - StreamReaderWriter

Index

Properties

Methods

applyCommit createStreamFromGenesis requestAnchor

Properties

signer

signer: CeramicSigner

Methods

applyCommit

applyCommit<T>(streamId: string | StreamID, commit: CeramicCommit, opts?: UpdateOpts): Promise<T>
Applies commit on the existing stream
Type Parameters
- T extends Stream<T>
Parameters
- streamId: string | StreamID
  
  Stream ID
- commit: CeramicCommit
  
  Commit to be applied
- Optional opts: UpdateOpts
  
  Initialization options
Returns Promise<T>
- Defined in packages/common/src/stream-writer.ts:25

createStreamFromGenesis

createStreamFromGenesis<T>(type: number, genesis: any, opts?: CreateOpts): Promise<T>
Create Stream from genesis commit
Type Parameters
- T extends Stream<T>
Parameters
- type: number
  
  Stream type
- genesis: any
  
  Genesis commit
- Optional opts: CreateOpts
  
  Initialization options
Returns Promise<T>
- Defined in packages/common/src/stream-writer.ts:13

requestAnchor

requestAnchor(streamId: string | StreamID, opts?: LoadOpts & AnchorOpts): Promise<AnchorStatus>
Requests an anchor for the given StreamID if the Stream isn't already anchored. Returns the new AnchorStatus for the Stream.
Parameters
- streamId: string | StreamID
- Optional opts: LoadOpts & AnchorOpts
  
  used to load the current Stream state
Returns Promise<AnchorStatus>
- Defined in packages/common/src/stream-writer.ts:37