arborea v0.0.2

Arborea

Overview

Arborea lets you create, manage and traverse tree structures. It's very basic and simple.

Quick start

First, make sure Node is installed on your machine. Then run this in your project folder:

$ npm i arborea

Create a tree:

const Tree = require('arborea')

const tree = new Tree()
tree.root.title = 'R00t'
tree.root.content = 'Hello world!'

const node = tree.createNode('foo', 'bar')
tree.root.appendChild(node)

Classes

Tree

Main class

Kind: global class
Properties

• Tree
  • new Tree([nodes])
  • .getNode([id]) ⇒ Node
  • .createNode([title], [content]) ⇒ Node
  • .deleteNode(node, recursive)
  • .import(nodes)
  • .export() ⇒ string

new Tree(nodes)

Create a new tree or import one

tree.getNode(id) ⇒ Node

Takes a Node ID and returns the corresponding node.

Kind: instance method of Tree
Returns: Node - The Node that got got

tree.createNode(title, content) ⇒ Node

Creates a new Node in the tree.

Kind: instance method of Tree
Returns: Node - The created Node

tree.deleteNode(node, recursive)

Deletes passed node from the tree.

Kind: instance method of Tree

tree.import(nodes)

Imports a tree structure to replace the current one. If a string is provided, it will be parsed as JSON. This method is automatically called if an argument is provided to the Tree constructor.

Kind: instance method of Tree

tree.export() ⇒ string

Exports the nodes in the tree as a JSON string. Data of this type can later be imported to recreate the tree.

Kind: instance method of Tree
Returns: string - Nodes in JSON format.

Node

A node inside a tree. Nodes are created by instances of Tree; do not use this constructor to create Nodes!

Kind: global class
Properties

• Node
  • .appendChild(node)
  • .removeChild(node)
  • .createChild([title], [content]) ⇒ Node
  • .deleteChild(node)

node.appendChild(node)

Appends the passed Node to this Node. If passed Node is child to another Node, it will be removed as a child from that one.

Kind: instance method of Node

node.removeChild(node)

Removes the passed Node as a child from this Node. The Node is not deleted from the Tree.

Kind: instance method of Node

node.createChild(title, content) ⇒ Node

Creates a new Node in the Tree and appends it as a child to this Node.

Kind: instance method of Node
Returns: Node - The created Node

node.deleteChild(node)

Removes the passed Node as a child from this Node and deletes it from the Tree.

Kind: instance method of Node