Class Property

Readonlyaddress

Readonlybehavior

Readonlydatabase

medallion

• get medallion(): number

• Returns number

offset

• get offset(): number

• Returns number

timestamp

• get timestamp(): number

• Returns number

[inspectSymbol]

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

• Parameters

  • depth: any
  • opts: any

  Returns string

clear

• clear(purge?: boolean, meta?: Meta): Promise<Muid>

• Parameters

  • Optionalpurge: boolean
  • Optionalmeta: Meta

  Returns Promise<Muid>

delete

• delete(key: Addressable, meta?: Meta): Promise<Muid>

• Adds a deletion marker (tombstone) for a particular key in the directory. The corresponding value will be seen to be unset in the data model.

  Parameters

  • key: Addressable
  • Optionalmeta: Meta

  Returns Promise<Muid>

  a promise that resolves to the address of the newly created deletion entry

equals

• equals(other: any): boolean

• Parameters

  • other: any

  Returns boolean

get

• get(key: Addressable, asOf?: AsOf): Promise<Value | Container>

• Returns a promise that resolves to the most recent value set for the given key, or undefined.

  Parameters

  • key: Addressable
  • OptionalasOf: AsOf

  Returns Promise<Value | Container>

  undefined, a basic value, or a container

getName

• getName(asOf?: AsOf): Promise<string>

• Parameters

  • OptionalasOf: AsOf

  Returns Promise<string>

has

• has(key: Addressable, asOf?: AsOf): Promise<boolean>

• Parameters

  • key: Addressable
  • OptionalasOf: AsOf

  Returns Promise<boolean>

reset

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

• Reset this Container to a previous time. If no time is specified, the container will be cleared.

  Parameters

  • OptionaltoTime: AsOf
  • Optionalrecurse: any
  • Optionalmeta: Meta

  Returns Promise<void>

  Argument

  toTime Optional time to reset to. If absent, the container will be cleared.

  Argument

  recurse Recursively reset all child containers held by this container at reset time?

  Argument

  meta Metadata to be used in the reset.

resetProperties

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

• Reset the properties associated with this container to a previous time.

  Parameters

  • OptionaltoTime: AsOf

    optional timestamp to reset to. If not provided, the properties will be deleted.
  • Optionalmeta: Meta

  Returns Promise<void>

set

• set(key: Addressable, value: Value | Container, meta?: Meta): Promise<Muid>

• Sets a key/value association in a directory. If a bundler is supplied, the function will add the entry to that bundler and return immediately (you'll need to addBundler manually in that case). If the caller does not supply a bundler, then one is created on the fly, and then this method will await on the bundler being added to the database instance. This is to allow simple console usage like: await myDirectory.set("foo", "bar");

  Parameters

  • key: Addressable
  • value: Value | Container
  • Optionalmeta: Meta

  Returns Promise<Muid>

  a promise that resolves to the address of the newly created entry

setName

• setName(name: string, meta?: Meta): Promise<Muid>

• Parameters

  • name: string
  • Optionalmeta: Meta

  Returns Promise<Muid>

size

• size(asOf?: AsOf): Promise<number>

• Parameters

  • OptionalasOf: AsOf

  Returns Promise<number>

toJson

• toJson(
      indent?: number | boolean,
      asOf?: AsOf,
      seen?: Set<string>,
  ): Promise<string>

• Generates a JSON representation of the data in this container. Mostly intended for demo/debug purposes.

  Parameters

  • indent: number | boolean = false

    true to pretty print
  • OptionalasOf: AsOf

    effective time
  • Optionalseen: Set<string>

    (internal use only! This prevents cycles from breaking things)

  Returns Promise<string>

  a JSON string

toMap

• toMap(asOf?: AsOf): Promise<Map<StorageKey, Value | Container>>

• Dumps the contents of this directory into a javascript Map; mostly useful for debugging though also could be used to create a backup of a database.

  Parameters

  • OptionalasOf: AsOf

    effective time to get the dump for, or undefined for the present

  Returns Promise<Map<StorageKey, Value | Container>>

  a javascript map from keys (numbers or strings) to values or containers

whatAmI

• whatAmI(): string

• Returns string