base-tree
Add a tree method to generate a hierarchical tree structure representing nested applications and child objects.
Install
Install with npm:
$ npm i base-tree --save
Usage
var tree = require('base-tree');
API
.tree
Creates a .tree
method on app
that will recursively generate a tree of nodes specified by the names
option passed in.
Params
-
options
{Object}: Options to use in.tree
method -
options.names
{String|Array}: Names of the collection objects to look for child nodes. -
options.method
{String}: Optional method names defined on theapp
. Defaults totree
. -
options.tree
{Function}: Optionaltree
function to use to generate the node or tree of nodes for the current app. Takesapp
andoptions
as parameters. -
options.getLabel
{Function}: Get a label for the node being built. Takesapp
andoptions
as parameters. -
options.getMetadata
{Function}: Get a metadata object for the node being built. Takesapp
andoptions
as parameters. -
returns
{Function}: plugin
Example
var app = new Base();
app.use(tree({names: 'children'}));
app.children = {};
app.children.one = new Base();
app.children.two = new Base();
app.children.three = new Base();
console.log(app.tree());
console.log(archy(app.tree()));
options.tree
Default tree building function. Gets the label and metadata properties for the current app
and recursively generates the child nodes and child trees if possible.
This method may be overriden by passing a .tree
function on options.
Params
-
app
{Object}: Current application to build a node and tree from. -
options
{Object}: Options used to control how thelabel
andmetadata
properties are retreived. -
returns
{Object}: Generated node containinglabel
,metadata
, andnodes
properties for current segment of a tree.
options.getLabel
Figure out a label to add for a node in the tree.
Params
-
app
{Object}: Current node/app being iterated over -
options
{Object}: PassgetLabel
on options to handle yourself. -
returns
{String}: label to be shown
options.getMetadata
Additional metadata that should be added to a node
Params
-
app
{Object}: Current node/app being iterated over -
options
{Object}: PassgetMetadata
on options to handle yourself. -
returns
{Object}: metadata object to add to node
Running Example
Clone the repository, install dependencies and run the example with node
.
$ git clone https://github.com/doowb/base-tree
$ cd base-tree
$ npm install
$ node example.js
The example will output the raw object and a formatted tree structure using archy
Related projects
- base-methods: base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage
- use: Easily add plugin support to your node.js application. | homepage
Running tests
Install dev dependencies:
$ npm i -d && npm test
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Author
Brian Woodward
License
Copyright © 2016 Brian Woodward Released under the MIT license.
This file was generated by verb on January 14, 2016.