Class Traversal

constructor

• new Traversal(
      graph: Graph | null,
      traversalStrategies: TraversalStrategies | null,
      gremlinLang?: default,
  ): Traversal

  Parameters

  • graph: Graph | null
  • traversalStrategies: TraversalStrategies | null
  • gremlinLang: default = ...

  Returns Traversal

graph

gremlinLang

results

OptionalsideEffects

traversalStrategies

_applyStrategies

• _applyStrategies(): Promise<void>

  Returns Promise<void>

getGremlinLang

• getGremlinLang(): default

  Returns default

hasNext

• hasNext(): Promise<boolean>

  Determines if there are any more items to iterate from the traversal.

  Returns Promise<boolean>

iterate

• iterate(): Promise<void>

  Iterates all Traverser instances in the traversal.

  Returns Promise<void>

next

• next<T>(): Promise<IteratorResult<T, null>>

  Async iterator method implementation. Returns a promise containing an iterator item.

  Type Parameters

  • T

  Returns Promise<IteratorResult<T, null>>

toJSON

• toJSON(): string

  Returns step instructions during JSON serialization

  Returns string

toList

• toList<T>(): Promise<T[]>

  Returns an Array containing the traverser objects.

  Type Parameters

  • T

  Returns Promise<T[]>

toString

• toString(): string

  Returns the GremlinLang representation of the traversal

  Returns string