Class ContainerAbstract

Readonlybehavior

Readonlydatabase

[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>

getName

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

• Parameters

  • OptionalasOf: AsOf

  Returns Promise<string>

Abstractreset

• 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>

setName

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

• Parameters

  • name: string
  • Optionalmeta: Meta

  Returns Promise<Muid>

Abstractsize

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

• Parameters

  • OptionalasOf: AsOf

  Returns Promise<number>

AbstracttoJson

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

• Parameters

  • indent: number | boolean
  • OptionalasOf: AsOf
  • Optionalseen: Set<string>

  Returns Promise<string>

whatAmI

• whatAmI(): string

• Returns string