Model stream implementation

Hierarchy

  • Stream
    • Model

Constructors

  • Parameters

    • state$: RunningStateLike
    • _context: Context

    Returns Model

Properties

state$: RunningStateLike
MODEL: StreamID = ...
STREAM_TYPE_ID: number = 2
STREAM_TYPE_NAME: string = 'model'

Accessors

  • get allCommitIds(): CommitID[]
  • Returns CommitID[]

  • get anchorCommitIds(): CommitID[]
  • Returns CommitID[]

  • get api(): CeramicApi
  • Returns CeramicApi

  • get commitId(): CommitID
  • Returns CommitID

  • get id(): StreamID
  • Returns StreamID

  • get state(): StreamState
  • Returns StreamState

  • get tip(): CID
  • Returns CID

Methods

  • Makes this document read-only. After this has been called any future attempts to call mutation methods on the instance will throw.

    Returns void

  • Returns Promise<AnchorStatus>

  • Parameters

    • Optional opts: LoadOpts

    Returns Promise<void>

  • 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>