Function walkTree

walkTree<T = void>(
    root: object,
    visit: (node: object) => undefined | T,
    mode: WalkTreeMode,
): undefined | T
Walks a tree, running the predicate function for each node. If the predicate function returns something other than undefined, then the walk will be stopped and the function will return the returned value.
Type Parameters
- T = void
  Returned node type, defaults to void.
Parameters
- root: object
  Subtree root node.
- visit: (node: object) => undefined | T
  Function that will be run for each node of the tree.
- mode: WalkTreeMode
  Mode to walk the tree, as defined in WalkTreeMode.
Returns undefined | T
The value returned by the predicate function that stopped the walk, or undefined if the walk was completed.