Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
d-forest
Advanced tools
Readme
A lightweight JavaScript library for searching object in a tree-like structure.
npm install d-forest --save
const df = require('d-forest');
// data can have array of objects
const data = {
c1: { name: 'category1', active: false },
c2: {
name: 'category2',
active: true,
products: {
p1: { name: 'product21', active: false },
p2: { name: 'product22', active: true },
p3: { name: 'product23', active: false },
},
},
c3: {
name: 'category3',
active: true,
products: {
p1: { name: 'product31', active: false },
p2: { name: 'product32', active: true },
},
},
};
// "node" can be any object on the tree
df.findNode(data, (node) => node.name === 'category3');
// { name: 'category3', active: true, products: [Object] }
// "leaf" can be any object which don't have children i.e. bottom nodes
df.findLeaf(data, (leaf) => leaf.name === 'product22');
// { name: 'product22', active: true }
// this method is useful when you know that the object you want to find is a leaf
// note that every leaf is a node but not every node is a leaf
let level = df.maxHeight(data) - 1;
// level argument (optional) can be used to map leaves at specific level
df.mapLeaves(data, (leaf) => leaf.name, level);
// ['product21', 'product22', 'product23', 'product31', 'product32']
df.everyNode(data, (node) => node.hasOwnProperty('active'));
// false
df.everyLeaf(data, (leaf) => leaf.hasOwnProperty('active'));
// true
df.minHeight(data); // 2
df.maxHeight(data); // 4
// returns an array containing all nodes at given level
df.nodesByLevel(data, 1); // level >= 0
// [
// { name: 'category1', active: false },
// { name: 'category2', active: true, products: [Object] },
// { name: 'category3', active: true, products: [Object] }
// ]
// returns single output value for each path from top to bottom
// initial value must be provided
df.reduce(data, (acc, cur) => (cur.name ? `${acc}/${cur.name}` : acc), '');
// [
// '/category1',
// '/category2/product21',
// '/category2/product22',
// '/category2/product23',
// '/category3/product31',
// '/category3/product32'
// ]
// returns object hierarchy from root
const nodes = df.hierarchy(data, (node) => node.name === 'product31');
nodes.map((node) => node.name).filter(Boolean);
// ['category3', 'product31']
df.findLevel(data, (node) => node.name === 'category2'); // 1
df.findLevel(data, (node) => node.name === 'product21'); // 3
df.findPath(data, (node) => node.name === 'product22');
// [ 'c2', 'products', 'p2' ]
df.findByPath(data, ['c2', 'products', 'p2']);
// { name: 'product22', active: true }
Following methods don't mutate data, instead return new one with shared mutable state.
df.removeLeaves(data, (leaf) => leaf.active === false);
// {
// c2: {
// name: 'category2',
// active: true,
// products: { p2: [Object] }
// },
// c3: {
// name: 'category3',
// active: true,
// products: { p2: [Object] }
// }
// }
df.updateNodes(
data,
(node, depth) => depth === 1 && node.active,
(node) => ({ ...node, products: null })
);
// {
// c1: { name: 'category1', active: false },
// c2: { name: 'category2', active: true, products: null },
// c3: { name: 'category3', active: true, products: null }
// }
df.removeByLevel(data, 2);
// {
// c1: { name: 'category1', active: false },
// c2: { name: 'category2', active: true },
// c3: { name: 'category3', active: true }
// }
FAQs
Find nested object in a tree-like structure
The npm package d-forest receives a total of 1,150 weekly downloads. As such, d-forest popularity was classified as popular.
We found that d-forest demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.