structz

ES2015 Class versions of a Node and Tree

Install

npm instal structz or yarn add structz

const Structz = require('structz'),
  Node = Structz.Node,
  Tree = Structz.Tree;

Documentation

See docs/index.html for up to date documentation.

Node

Class representing a Node data structure type

Kind: global class

• Node
  • .children ⇒ Array
  • .value ⇒ *
  • .value
  • .isRoot() ⇒ boolean
  • .hasChildren() ⇒ boolean
  • .append(child) ⇒ Node
  • .toString() ⇒ string

node.children ⇒ Array

Returns an array of child nodes.

Kind: instance property of Node

node.value ⇒ *

Returns the value of the this.attributes.

Kind: instance property of Node

node.value

Sets the value of this.attributes.

Kind: instance property of Node

node.isRoot() ⇒ boolean

Detects if this Node is a parent node or not.

Kind: instance method of Node

node.hasChildren() ⇒ boolean

Detects if this node has children or not.

Kind: instance method of Node

node.append(child) ⇒ Node

Appends a child Node to this Node.

Kind: instance method of Node

node.toString() ⇒ string

Returns a String that represents this Node.

Kind: instance method of Node

Classes

Tree

Class representing a Tree data structure type that contains a Root node

Constants

_

Created by codeforcoffee on 6/2/17.

Tree

Class representing a Tree data structure type that contains a Root node

Kind: global class

• Tree
  • new Tree(root)
  • instance
    • .root ⇒ *
  • static
    • .map(node, func, tree) ⇒ *

new Tree(root)

Instantiates a Node as a Binary Tree

tree.root ⇒ *

Returns the root of the Node.

Kind: instance property of Tree

Tree.map(node, func, tree) ⇒ *

Performs a function on a Node with the provided function and returns the output. Optionally accepts a Tree to perform this otherwise a new Tree is instantiated and returned (breaks immutability).

Kind: static method of Tree

_

Created by codeforcoffee on 6/2/17.

Kind: global constant

Changelog

• 0.1.1 - Added Test Coverage
• 0.1.0 - Initial release.