Package Exports
- d-forest
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (d-forest) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
A lightweight JavaScript library for searching and retrieving objects in a tree-like structure.
Install
npm install d-forest
Usage
const df = require('d-forest');
// data can be object or array of objects
const data = [
{ name: 'category1', active: false },
{
name: 'category2', active: true,
products: [
{ name: 'product21', active: false },
{ name: 'product22', active: true },
{ name: 'product23', active: false },
],
},
{
name: 'category3', active: true,
products: [
{ name: 'product31', active: false },
{ name: 'product32', active: true },
],
},
];
// "node" can be any object on the tree
const res1 = df(data).findNode(node => node.name === 'category3');
console.log(res1);
// {
// name: 'category3', active: true,
// products: [Object]
// }
// "leaf" can be any object which don't have children i.e. bottom nodes
// it has better performance over findNode as it skips unnecessary comparisons
const res2 = df(data).findLeaf(leaf => leaf.name === 'product22');
console.log(res2);
// { name: 'product22', active: false }Methods
- findNode
- findNodes
- findLeaf
- findLeaves
- forEachNode
- forEachLeaf
- mapLeaves
- nodesByLevel
// returns array containing all nodes at given level
const res3 = df(data).nodesByLevel(1); // should be greater than 0
console.log(res3);
// [
// { name: 'product21', active: false },
// { name: 'product22', active: true },
// ...
// { name: 'product32', active: true }
// ]- removeNode
- removeLeaf
- objectify
// returns a copy by converting each array (if any) to object
const res = df(data).objectify(node => node.name);
console.log(res);
// {
// category1: { name: 'category1', active: false },
// category2: {
// name: 'category2', active: true,
// products: Object
// },
// ...
// }- reduce
// returns single output value for each path from top to bottom
const res = df(data).reduce(
(acc, cur) => (acc + cur.name + '/'), '' // initial value must be provided
);
console.log(res);
// ["category1/", "category2/product21/", ..., "category3/product32/"]