Class Model

Model stream implementation

Hierarchy

Stream
- Model

Index

Constructors

Properties

state$ MODEL STREAM_TYPE_ID STREAM_TYPE_NAME

Accessors

allCommitIds anchorCommitIds api commitId content id isReadOnly metadata state tip

Methods

makeReadOnly requestAnchor sync assertComplete create load

Constructors

constructor

new Model(state$: RunningStateLike, _context: Context): Model
Parameters
- state$: RunningStateLike
- _context: Context
Returns Model
Inherited from Stream.constructor
- Defined in packages/common/lib/stream.d.ts:111

Properties

`Protected` `Readonly` state$

state$: RunningStateLike

`Static` `Readonly` MODEL

MODEL: StreamID = ...

`Static` STREAM_TYPE_ID

STREAM_TYPE_ID: number = 2

`Static` STREAM_TYPE_NAME

STREAM_TYPE_NAME: string = 'model'

Accessors

allCommitIds

get allCommitIds(): CommitID[]
Returns CommitID[]
Inherited from Stream.allCommitIds
- Defined in packages/common/lib/stream.d.ts:118

anchorCommitIds

get anchorCommitIds(): CommitID[]
Returns CommitID[]
Inherited from Stream.anchorCommitIds
- Defined in packages/common/lib/stream.d.ts:119

api

get api(): CeramicApi
Returns CeramicApi
Inherited from Stream.api
- Defined in packages/common/lib/stream.d.ts:113

commitId

get commitId(): CommitID
Returns CommitID
Inherited from Stream.commitId
- Defined in packages/common/lib/stream.d.ts:117

content

get content(): ModelDefinition
Returns ModelDefinition
Overrides Stream.content
- Defined in packages/stream-model/src/model.ts:158

id

get id(): StreamID
Returns StreamID
Inherited from Stream.id
- Defined in packages/common/lib/stream.d.ts:112

isReadOnly

get isReadOnly(): boolean
Returns boolean
Overrides Stream.isReadOnly
- Defined in packages/stream-model/src/model.ts:306

metadata

get metadata(): ModelMetadata
Returns ModelMetadata
Overrides Stream.metadata
- Defined in packages/stream-model/src/model.ts:162

state

get state(): StreamState
Returns StreamState
Inherited from Stream.state
- Defined in packages/common/lib/stream.d.ts:120

tip

get tip(): CID
Returns CID
Inherited from Stream.tip
- Defined in packages/common/lib/stream.d.ts:116

Methods

makeReadOnly

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

Returns void
Overrides Stream.makeReadOnly
- Defined in packages/stream-model/src/model.ts:301

requestAnchor

requestAnchor(): Promise<AnchorStatus>
Returns Promise<AnchorStatus>
Inherited from Stream.requestAnchor
- Defined in packages/common/lib/stream.d.ts:122

sync

sync(opts?: LoadOpts): Promise<void>
Parameters
- Optional opts: LoadOpts
Returns Promise<void>
Inherited from Stream.sync
- Defined in packages/common/lib/stream.d.ts:121

`Static` assertComplete

assertComplete(content: ModelDefinition, streamId?: string | StreamID | CommitID): void
Asserts that all the required fields for the Model are set, and throws an error if not.
Parameters
- content: ModelDefinition
- Optional streamId: string | StreamID | CommitID
Returns void
- Defined in packages/stream-model/src/model.ts:196

`Static` create

create(ceramic: CeramicApi, content: ModelDefinition, metadata?: ModelMetadataArgs): Promise<Model>
Creates a Model.
Parameters
- ceramic: CeramicApi
  
  Instance of CeramicAPI used to communicate with the Ceramic network
- content: ModelDefinition
  
  contents of the model to create
- Optional metadata: ModelMetadataArgs
Returns Promise<Model>
Overrides Stream.create
- Defined in packages/stream-model/src/model.ts:172

`Static` load

load(ceramic: CeramicApi, streamId: string | StreamID | CommitID, opts?: LoadOpts): Promise<Model>
Loads a Model from a given StreamID
Parameters
- ceramic: CeramicApi
  
  Instance of CeramicAPI used to communicate with the Ceramic network
- streamId: string | StreamID | CommitID
  
  StreamID to load. Must correspond to a Model
- opts: LoadOpts = {}
  
  Additional options
Returns Promise<Model>
- Defined in packages/stream-model/src/model.ts:232