Module: tiny-forest

A small library of classes for managing static tree data structures.
Source:

Classes

Tree
TreeNode

Type Definitions

TreeFallback(input) → {*}

Parameters:
Name Type Description
input Object An input passed to the object.
Properties
Name Type Description
error Error The error thrown.
node TreeNode The node where the error was thrown.
path Array.<TreeNode> The full path leading up to the error.
Source:
Returns:
Type
*

TreeNodeIndex(inputopt) → {Object}

Parameters:
Name Type Attributes Description
input * <optional>
An optional input passed to the function.
Source:
Returns:
Returns an object containing the next node, the full path up to this node and an optional result value from the node.
Type
Object

TreeOptions

Type:
  • Object
Properties:
Name Type Attributes Default Description
tree Object Dictionary of TreeNodes representing the data structure.
rootIndex int <optional>
"root" The index of the root.
fallback TreeFallback <optional>
Fallback function for Trees containing nodes with asynchronous conditionals.
Source: