Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @ceramicnetwork/stream-tile

Ceramic TileDocument stream type

This package contains Tile stream implementation.

Installation

npm install @ceramicnetwork/stream-tile

Contributing

We are happy to accept small and large contributions. Make sure to check out the Ceramic specifications for details of how the protocol works.

License

Apache-2.0 or MIT

Index

References

TileDocument

Re-exports TileDocument

TileMetadataArgs

Re-exports TileMetadataArgs

Functions

_ensureAuthenticated

  • _ensureAuthenticated(signer: CeramicSigner): Promise<void>

headerFromMetadata

  • headerFromMetadata(metadata?: TileMetadataArgs | StreamMetadata): CommitHeader

throwReadOnlyError

  • throwReadOnlyError(): Promise<void>

Object literals

Const DEFAULT_CREATE_OPTS

DEFAULT_CREATE_OPTS: object

anchor

anchor: boolean = true

publish

publish: boolean = true

sync

sync: SyncOptions = SyncOptions.PREFER_CACHE

Const DEFAULT_LOAD_OPTS

DEFAULT_LOAD_OPTS: object

sync

sync: SyncOptions = SyncOptions.PREFER_CACHE

Const DEFAULT_UPDATE_OPTS

DEFAULT_UPDATE_OPTS: object

anchor

anchor: boolean = true

publish

publish: boolean = true