Class Stream`Abstract`

Describes common stream attributes

Hierarchy

Observable<StreamState>
- Stream

Implements

StreamStateHolder

Index

Constructors

Properties

isReadOnly state$

Accessors

allCommitIds anchorCommitIds api commitId content id metadata state tip

Methods

makeReadOnly requestAnchor sync

Constructors

constructor

new Stream(state$: RunningStateLike, api: StreamReaderWriter): Stream
Parameters
- state$: RunningStateLike
- api: StreamReaderWriter
Returns Stream
Overrides Observable<StreamState>.constructor
- Defined in packages/common/src/stream.ts:215

Properties

`Abstract` isReadOnly

isReadOnly: boolean

True if 'makeReadOnly()' has been called previously.

`Protected` `Readonly` state$

state$: RunningStateLike

Accessors

allCommitIds

get allCommitIds(): CommitID[]
Lists available commits

Returns CommitID[]
- Defined in packages/common/src/stream.ts:248

anchorCommitIds

get anchorCommitIds(): CommitID[]
Lists available commits that correspond to anchor commits

Returns CommitID[]
- Defined in packages/common/src/stream.ts:255

api

get api(): StreamReaderWriter
Returns StreamReaderWriter
- Defined in packages/common/src/stream.ts:226

commitId

get commitId(): CommitID
Returns CommitID
- Defined in packages/common/src/stream.ts:241

content

get content(): any
Returns any
- Defined in packages/common/src/stream.ts:232

id

get id(): StreamID
Returns StreamID
Implementation of StreamStateHolder.id
- Defined in packages/common/src/stream.ts:222

`Abstract` metadata

get metadata(): Record<string, any>
Returns Record<string, any>
- Defined in packages/common/src/stream.ts:230

state

get state(): StreamState<StreamMetadata>
Returns StreamState<StreamMetadata>
Implementation of StreamStateHolder.state
- Defined in packages/common/src/stream.ts:261

tip

get tip(): CID<unknown, number, number, Version>
Returns CID<unknown, number, number, Version>
- Defined in packages/common/src/stream.ts:237

Methods

`Abstract` makeReadOnly

makeReadOnly(): void
Makes this stream read-only. After this has been called any future attempts to call mutation methods on the instance will throw.

Returns void
- Defined in packages/common/src/stream.ts:279

requestAnchor

requestAnchor(): Promise<AnchorStatus>
Returns Promise<AnchorStatus>
- Defined in packages/common/src/stream.ts:271

sync

sync(opts?: LoadOpts): Promise<void>
Parameters
- opts: LoadOpts = {}
Returns Promise<void>
- Defined in packages/common/src/stream.ts:265