Class Database

constructor

• new Database(
      args?: { identity?: string; logger?: CallBack; store?: Store },
  ): Database

• Parameters

  • Optionalargs: { identity?: string; logger?: CallBack; store?: Store }

  Returns Database

Readonlypeers

ready

Readonlystore

Static ReadonlyPROTOCOL

Staticrecent

• get recent(): Database

• Returns Database

[inspectSymbol]

• "[inspectSymbol]"(depth: any, opts: any): string

• Parameters

  • depth: any
  • opts: any

  Returns string

addListener

• addListener(
      listener: BundleListener,
      containerMuid?: Muid,
      remoteOnly?: boolean,
  ): void

• Adds a listener that will be called every time a bundle is received with the BundleInfo (which contains chain information, timestamp, and bundle comment).

  Parameters

  • listener: BundleListener

    a callback to be invoked when a change occurs in the database or container
  • OptionalcontainerMuid: Muid

    the Muid of a container to subscribe to. If left out, subscribe to all containers.
  • remoteOnly: boolean = false

  Returns void

close

• close(): Promise<void>

• Closes connections to peers and closes the store.

  Returns Promise<void>

connectTo

• connectTo(
      target: string,
      options?: {
          authToken?: string;
          onClose?: CallBack;
          resolveOnOpen?: boolean;
          retryOnDisconnect?: boolean;
      },
  ): Promise<Peer>

• Initiates a websocket connection to a peer.

  Parameters

  • target: string

    a websocket uri, e.g. "ws://127.0.0.1:8080/"
  • Optionaloptions: {
        authToken?: string;
        onClose?: CallBack;
        resolveOnOpen?: boolean;
        retryOnDisconnect?: boolean;
    }

  Returns Promise<Peer>

  a promise to the peer

getLastLink

• getLastLink(): BundleInfo

• Returns BundleInfo

getRoot

• getRoot(): Directory

• Returns Directory

reset

• reset(toTime?: AsOf, meta?: Meta): Promise<void>

• Parameters

  • OptionaltoTime: AsOf
  • Optionalmeta: Meta

  Returns Promise<void>

startBundle

• startBundle(meta?: Meta): Promise<Bundler>

• Parameters

  • Optionalmeta: Meta

  Returns Promise<Bundler>

toString

• toString(): string

• Returns string