Class WalkResult

constructor

• new WalkResult(
      nodes: Node[],
      vertices: number,
      edges: number,
      elapsedMicroseconds: number,
      totalReadings: number,
  ): WalkResult

  Parameters

  • nodes: Node[]
  • vertices: number
  • edges: number
  • elapsedMicroseconds: number
  • totalReadings: number

  Returns WalkResult

Readonlyedges

ReadonlyelapsedMicroseconds

Readonlynodes

ReadonlytotalReadings

Readonlyvertices

copyWithFixedNodes

• copyWithFixedNodes(): WalkResult

  Makes a copy with the nodes also being copies instead of references to those in the current grid.

  For performance reasons, nodes is an array of nodes in the referenced grid. If the intent is to have the walk capture the current state of the grid before the grid mutates, the default behavior will not be enough. Instead, use this to make sure that the nodes are correctly copied.

  Returns WalkResult

findNodeAt

• findNodeAt(
      cursor: number,
  ): readonly [Node | undefined, number, number | undefined]

  Finds the node at a given cursor position.

  Parameters

  • cursor: number

    The cursor position.

  Returns readonly [Node | undefined, number, number | undefined]

  A tuple containing the found node, the cursor index, and the node index.

readingsAsStrings

• readingsAsStrings(): string[]

  The readings of the nodes as a list of strings.

  Returns string[]

  A list of strings.

valuesAsStrings

• valuesAsStrings(): string[]

  The values of the nodes as a list of strings.

  Returns string[]

  A list of strings.