Add a tree method to generate a hierarchical tree structure representing nested applications and child objects.
MIT License
Add a tree method to generate a hierarchical tree structure representing nested applications and child objects.
Install with npm:
$ npm i base-tree --save
var tree = require('base-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
methodoptions.names
{String|Array}: Names of the collection objects to look for child nodes.options.method
{String}: Optional method names defined on the app
. Defaults to tree
.options.tree
{Function}: Optional tree
function to use to generate the node or tree of nodes for the current app. Takes app
and options
as parameters.options.getLabel
{Function}: Get a label for the node being built. Takes app
and options
as parameters.options.getMetadata
{Function}: Get a metadata object for the node being built. Takes app
and options
as parameters.returns
{Function}: pluginExample
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()));
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 the label
and metadata
properties are retreived.returns
{Object}: Generated node containing label
, metadata
, and nodes
properties for current segment of a tree.Figure out a label to add for a node in the tree.
Params
app
{Object}: Current node/app being iterated overoptions
{Object}: Pass getLabel
on options to handle yourself.returns
{String}: label to be shownAdditional metadata that should be added to a node
Params
app
{Object}: Current node/app being iterated overoptions
{Object}: Pass getMetadata
on options to handle yourself.returns
{Object}: metadata object to add to nodeClone 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
Install dev dependencies:
$ npm i -d && npm test
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Brian Woodward
Copyright © 2016 Brian Woodward Released under the MIT license.
This file was generated by verb on January 14, 2016.