Options
All
  • Public
  • Public/Protected
  • All
Menu

Describes Ceramic node API

Hierarchy

  • CeramicApi

Index

Properties

Optional did

did: DID

pin

pin: PinApi

Methods

addDoctypeHandler

applyCommit

applyRecord

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>

getSupportedChains

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

loadDocument

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

loadDocumentCommits

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

loadDocumentRecords

  • loadDocumentRecords(docId: DocID | string): Promise<Array<Record<string, any>>>
  • Load all document commits by document ID

    deprecated

    See loadDocumentCommits

    Parameters

    • docId: DocID | string

      Document ID

    Returns Promise<Array<Record<string, any>>>

setDIDProvider

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