Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

tree-node-utils

Package Overview
Dependencies
Maintainers
1
Versions
8
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

tree-node-utils

A set of functions for accessing, searching, filtering data nodes in a tree data structure.

  • 3.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
37
increased by12.12%
Maintainers
1
Weekly downloads
 
Created
Source

tree-node-utils

A set of functions for accessing, searching, filtering data nodes in a tree data structure.

It works on tree data structures like this:

const tree = [
  {
    text: 'Computer',
    key: 'a',
    children: [
      {
        text: 'Desktop',
        key: 'd',
      },
      {
        text: 'Laptop',
        key: 'l',
      },
      {
        text: 'Mobile',
        key: 'm',
        children: [
          {
            text: 'Smart Phone',
            key: 's',
          },
          {
            text: 'Tablet',
            key: 't',
            children: [
              {
                text: 'Ipad',
                key: 'ip',
              },
              ...
            ],
          },
          ...
        ],
      },
      ...
    ],
  },
  ...
];


And provides the following util functions:

NameDescription
hasChildren(node)Returns if the node has children node.
isBranch(node)Returns if the node has children field. This field could be empty;
getNodeByKey(treeNodes, key)Returns the data node having the matching 'key' value.
findNodes(treeNodes, predicate)Returns a flat array of nodes that pass the predicate(test) function.
filterNodes(treeNodes, predicate)Filters the tree data structure with the predicate function. i.e. Return a copy of the data tree with unmatching nodes removed.
sortNodes(treeNodes, compareFunction)Sort the treeNodes and children of every data node using the given compare function.
mapNodes(treeNodes, mapFunction)Return a new tree after applying a function to every nodes in the original tree. This function is useful for transforming nodes in a tree.
mapFunction has the signature of mapFunction(currentNode, parentNode) and should return a new node object.
renameChildrenFieldForNodes(treeNodes, newChildrenFieldName)Rename the 'childrenField' (e.g. 'children') to something else;

Note:

  1. treeNodes parameter is deliberately designed to be an array of nodes, instead of a single node, to provide more flexibility. The process a single root node tree, wrap the root node in an array.
  2. predicate is a callback function to test each node, including any children nodes of the tree. Return true to keep the node, false otherwise;
  3. compareFunction is the same function used by Array.sort;

All the callback functions (predicate, compareFunction and mapFunction) will receive the parents as the last parameters, containing the ancestors as an array.

Install

npm install tree-node-utils --save

Usage Example

import TreeNodeUtils from 'tree-node-utils';

const config = {
  childrenField: 'children', // e.g. customise the field for children nodes. e.g. 'subItems', default 'children'
  keyField: 'key', // e.g. customise the field for node key. e.g. 'id', default 'key'
};

const treeNodeUtils = new TreeNodeUtils(config);

const node = treeNodeUtils.getNodeByKey(treeNodes, 'ip');
...

Live demo

demo.html

Keywords

FAQs

Package last updated on 29 Nov 2018

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc