Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface TreeCache

Hierarchy

  • TreeCache

Implemented by

Index

Methods

addErrorListener

addListener

close

  • close(): void

getCurrentChildren

  • getCurrentChildren(fullPath: string): Map<string, ChildData> | null
  • Return the current set of children at the given path, mapped by child name. There are no guarantees of accuracy; this is merely the most recent view of the data. If there is no node at this path, {@code null} is returned.

    Parameters

    • fullPath: string

      full path to the node to check

    Returns Map<string, ChildData> | null

    a possibly-empty list of children if the node is alive, or null

getCurrentData

  • getCurrentData(fullPath: string): ChildData | null
  • Return the current data for the given path. There are no guarantees of accuracy. This is merely the most recent view of the data. If there is no node at the given path, {@code null} is returned.

    Parameters

    • fullPath: string

      full path to the node to check

    Returns ChildData | null

    data if the node is alive, or null

removeErrorListener

removeListener

start

  • Start the cache. The cache is not started automatically. You must call this method.

    throws

    Exception errors

    Returns Promise<TreeCache>

    this once initialized

Generated using TypeDoc