Options
All
  • Public
  • Public/Protected
  • All
Menu

Ceramic client implementation

Hierarchy

  • CeramicClient

Implements

  • CeramicApi

Index

Constructors

constructor

Properties

Readonly _doctypeConstructors

_doctypeConstructors: Record<string, DoctypeConstructor<Doctype>>

Readonly context

context: Context

Readonly pin

pin: PinApi

Accessors

did

  • get did(): DID | undefined

Methods

_initPinApi

  • _initPinApi(): PinApi

addDoctypeHandler

  • addDoctypeHandler<T>(doctypeHandler: DoctypeHandler<T>): void

applyCommit

  • applyCommit<T>(docId: string | DocID, commit: CeramicCommit, opts?: DocOpts): Promise<T>

applyRecord

  • applyRecord<T>(docId: DocID | string, record: CeramicCommit, opts?: DocOpts): Promise<T>

close

  • close(): Promise<void>

createDocument

  • createDocument<T>(doctype: string, params: DocParams, opts?: DocOpts): Promise<T>

createDocumentFromGenesis

  • createDocumentFromGenesis<T>(doctype: string, genesis: any, opts?: DocOpts): Promise<T>

findDoctypeConstructor

  • findDoctypeConstructor<T>(doctype: string): DoctypeConstructor<T>

getSupportedChains

  • getSupportedChains(): Promise<Array<string>>

loadDocument

  • loadDocument<T>(docId: DocID | string): Promise<T>

loadDocumentCommits

  • loadDocumentCommits(docId: string | DocID): Promise<Record<string, any>[]>

loadDocumentRecords

  • loadDocumentRecords(docId: DocID | string): Promise<Array<Record<string, any>>>

multiQuery

  • multiQuery(queries: Array<MultiQuery>): Promise<Record<string, Doctype>>

setDIDProvider

  • setDIDProvider(provider: DIDProvider): Promise<void>