Type Alias WrappedNode<T>

Type declaration

• add: (child: WrappedNode<T> | TreeNode<T>) => WrappedNode<T>

  Adds a child node

• addValue: (value: T) => WrappedNode<T>

  Adds a new child node, with value as its value

• getValue: () => T | undefined

  Gets value of node, if defined

• hasAnyChild: (child: WrappedNode<T> | TreeNode<T>) => boolean

  Returns true if child is contained any any descendant

• hasAnyParent: (parent: WrappedNode<T> | TreeNode<T>) => boolean

  Returns true if parent is the immediate or ancestor parent for this node

• hasChild: (child: WrappedNode<T> | TreeNode<T>) => boolean

  Returns true if child is an immediate child of this node

• hasParent: (parent: WrappedNode<T> | TreeNode<T>) => boolean

  Returns true if parent is the immediate parent for this node

• queryValue: (value: T) => IterableIterator<WrappedNode<T>>

• remove: () => void

  Remove node and its children from tree

• wraps: TreeNode<T>

  Underlying Node

• findParentsValue: function

  • findParentsValue<T>(
        child: TreeNode<T>,
        value: T,
        eq: IsEqual<T>,
    ): undefined | WrappedNode<T>

    Returns the first parent that has a given value.

    Type Parameters

    • T

    Parameters

    • child: TreeNode<T>
    • value: T
    • eq: IsEqual<T>

    Returns undefined | WrappedNode<T>

• parentsValues: function

  • parentsValues<T>(child: TreeNode<T>): IterableIterator<T>

    Yields the node value of each parent of child. undefined values are not returned.

    Use 'queryParentsValue' to search for a particular value

    Type Parameters

    • T

    Parameters

    • child: TreeNode<T>

    Returns IterableIterator<T>

• queryParentsValue: function

  • queryParentsValue<T>(
        child: TreeNode<T>,
        value: T,
        eq?: IsEqual<T>,
    ): IterableIterator<WrappedNode<T>>

    Yields all parents of child that have a given value. Use 'findParentsValue' to find the first match only.

    Type Parameters

    • T

    Parameters

    • child: TreeNode<T>
    • value: T
    • Optionaleq: IsEqual<T>

    Returns IterableIterator<WrappedNode<T>>