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.
@thingsinc/treejs
Advanced tools
Readme
Simple Model for manipulating tree structure. This works with both browser and server side runtime.
bun install @thingsinc/treejs
pnpm install @thingsinc/treejs
npm install @thingsinc/treejs
yarn add @thingsinc/treejs
import { TreeFactory } from "@things/treejs";
// CommonJS
// const { TreeFactory } = require("@thingsinc/treejs")
const nodes = [
{
level: 0,
data: {
nodeKey: "root",
childNodeKey: "node1",
someProperty: {
// Set any data you want
},
},
},
{
level: 0,
data: {
nodeKey: "root",
childNodeKey: "node2",
someProperty: {
// Set any data you want
},
},
},
{
level: 1,
data: {
nodeKey: "node1",
childNodeKey: "node3",
someProperty: {
// Set any data you want
},
},
},
{
level: 1,
data: {
nodeKey: "node2",
childNodeKey: null,
someProperty: {
// Set any data you want
},
},
},
{
level: 2,
data: {
nodeKey: "node3",
childNodeKey: null,
someProperty: {
// Set any data you want
},
},
},
];
const tree = TreeFactory.create({
nodes,
key: "nodeKey",
childKey: "childNodeKey",
});
const num3Node = tree.find((node) => node.data.nodeKey === "node3");
console.log(num3Node);
/* output
Node {
level: 2,
parentKey: "node1",
children: [],
data: {
nodeKey: "node3",
someProperty: {},
},
isRoot: false,
isLeaf: true,
hasParent: true,
hasChildren: false,
move: [Function: move],
...
}
*/
console.log(num3Node.getParentNode());
/* output
Node {
level: 1,
parentKey: "root",
children: [
Node {
level: 2,
parentKey: "node1",
children: [],
data: [Object ...],
isRoot: false,
isLeaf: true,
hasParent: true,
hasChildren: false,
move: [Function: move],
...
}
],
data: {
nodeKey: "node1",
someProperty: {},
},
isRoot: false,
isLeaf: false,
hasParent: true,
hasChildren: true,
move: [Function: move],
...
}
*/
console.log(num3Node.getPath("nodeKey"));
/* output
root/node1/node3
*/
console.log(
num3Node.addChild({
data: { nodeKey: "node4", someProperty: {} },
}),
);
/* output
Node {
level: 3,
parentKey: "node3",
children: [],
data: {
nodeKey: "node4",
someProperty: {
someKey: 0.3392510625984465,
},
},
isRoot: false,
isLeaf: true,
hasParent: true,
hasChildren: false,
move: [Function: move],
...
}
*/
Tree#find
The find()
function of Tree instances returns the first Node in the provided tree that satisfies the provided testing function. If no values satisfy the testing function, undefined is returned.
Tree#findOrThrow
The findOrThrow()
function of Tree instances returns the first Node in the provided tree that satisfies the provided testing function. If no values satisfy the testing function, Error is returned.
Tree#findMany
The findMany()
function of Tree instances returns the all Node in the provided tree that satisfies the provided testing function. If no values satisfy the testing function, empty array is returned.
Tree#flat
The flat()
function of Tree instances returns new Array instances with the all Node up to the 0 depth.
Node#move
The move()
function of Node instances traverses the subtree that satisfies the provided test function. The action is a function which receives the visited Node as argument. The traversal can be halted by returning false from the action.
Node#findDescendantNodes
The findDescendantNodes()
function of Node instances returns the all Node in the subtree that satisfies the provided testing function.
Node#findParentNodes
The findParentNodes()
function of Node instances returns the all Node in the parent tree that satisfies the provided testing function.
Node#addChild
The addChild()
function of Node instances add the given node as child of this one and return the child node.
Node#drop
The drop()
function of Node instances drop the subtree starting at this node.
Node#getParentNode
The getParentNode()
function of Node instances return the parent Node.
Node#getAncestorNodes
The getAncestorNodes()
function of Node instances returns the all parent Node.
Node#getPath
The getPath(key)
function of Node instances returns a list of nodes up to the current node in path format with the given key.
root: {
level: 0,
data: {
key: 'level0Node'
},
children: [
{
level: 1,
data: {
key: 'level1Node'
},
children: [
{
level: 2,
data: {
key: 'level2Node'
},
children: []
}
]
}
]
}
// current node is level2
level2Node.getPath('key') // -> level0Node/level1Node/level2Node
Node#getTree
The getTree()
function of Node instances returns Tree instance.
This function for referencing tree instances from each node. Not each node holds a reference to a tree instance.
$ bun install
bun test
bun run build
git commit
bun run release
MIT License
FAQs
Simple Model for manipulating tree structure.
The npm package @thingsinc/treejs receives a total of 140 weekly downloads. As such, @thingsinc/treejs popularity was classified as not popular.
We found that @thingsinc/treejs demonstrated a healthy version release cadence and project activity because the last version was released less than 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.