Class TreeLinkerIterator

Class TreeLinkerIterator returns the next value taking a left-first approach down a tree.

Implements

Iterator<IsTreeNode>

Index

Constructors

Methods

Constructors

constructor

new TreeLinkerIterator(
current: IsTreeNode,
boundaryParent?: IsTreeNode,
): TreeLinkerIterator
Create an iterator starting at the given item.
Parameters
- current: IsTreeNode
  The item to start from.
- OptionalboundaryParent: IsTreeNode
  The parent of the nodes to stay within (null for the top of a tree), the whole tree when not given.
Returns TreeLinkerIterator
- Defined in src/recipes/TreeLinkerIterator.ts:16

Methods

next

next(value?: any): IteratorResult<IsTreeNode>
Get the current item and move on to the following one (left-first, down each branch).
Parameters
- Optionalvalue: any
  Not used, present to match the Iterator interface.
Returns IteratorResult<IsTreeNode>
The current item, or done when there are no more.
Implementation of Iterator.next
- Defined in src/recipes/TreeLinkerIterator.ts:26