Class: PathTraverser

PathTraverser

new PathTraverser(options)

Parameters:
Name Type Description
options Object

(as well as all of the Traverser options)

Properties
Name Type Description
path Array.<EdgeType>

the path to traverse.
onLeafNode PathTraverser.OnLeafNodeCb

callback called once a leaf (end of path) is visited

Extends

Members

allowLoops :Boolean

Type:
  • Boolean
Inherited From:

(nullable) excludeEdgeTypes :Object.<EdgeType, EdgeType>

Type:
Inherited From:

(nullable) excludeNodeTypes :Object.<NodeType, NodeType>

Type:
Inherited From:

maxDepth :Number

Type:
  • Number
Inherited From:

(nullable) onlyEdgeTypes :Object.<EdgeType, EdgeType>

Type:
Inherited From:

(nullable) onlyNodeTypes :Object.<NodeType, NodeType>

Type:
Inherited From:

onTraverseEdge :OnTraverseEdgeCb

Type:
  • OnTraverseEdgeCb
Inherited From:

onVisitNode :OnVisitNodeCb

Type:
  • OnVisitNodeCb
Inherited From:

shouldTraverseEdge :Traverser.ShouldTraverseEdgeCb

Type:
Inherited From:

shouldVisitNode :Traverser.ShouldVisitNodeCb

Type:
Inherited From:

Methods

getLeafNodes(rootNode) → {Array.<Node>}

Traverse from the rootNode and return a list of Nodes at the end of the path.

Parameters:
Name Type Description
rootNode Node
Returns:
Type
Array.<Node>

traverse(rootNode) → {Traverser.TraversalResult}

Traverse the graph from the given Node.

Parameters:
Name Type Description
rootNode Node
Inherited From:
Returns:
Type
Traverser.TraversalResult

Type Definitions

OnLeafNodeCb(node, meta) → {Boolean}

Parameters:
Name Type Description
node Node
meta Traverser.NodeTraversalMeta
Returns:
Type
Boolean