N ary tree
n-ary tree(also known as k-ary
or k-way
tree) implementation in JavaScript(TypeScript)
.
Installation
- Using npm
$ npm i n-ary-tree
- Using yarn
$ yarn add n-ary-tree
Tree node structures
User-defined tree node fields have supported by all available methods. Just keep the last parameter is a structure like:
Default structure fields
By default, we will use value
field as the value of tree node, children
field as the children of tree node.
Examples
val
field will be regarded as node actual value, descendants
field in the tree node will be regraded as node children field.
APIs
findNodes
Get all matched nodes.
findNodestree, // -> {// nodes: [{ value: 111 }],// values: [111]// }findNodestree, , // Equivalent to findNodes(tree, [111]), { value: 'value', children: 'children' }// is default preset.
findPathNodes
Get nodes sequences if tree path exist.
findPathNodestree, /** * [ * { value: 1, children: ... }, * { value: 11, children: ... }, * { value: 111, children: ...} * ] */ findPathNodestree, /** * [ * { value: 1, children: ... } * ] */
findPath
Find the latest matched path.
findPathtree, /** * [ * { value: 1, children: ... }, * { value: 12, children: ... }, * { value: 121, children: ...} * ] */findPathtree, // []
findAllPaths
Find all matched paths.
findAllPathstree, /** * [ * [ * { value: 1, children: ... }, * { value: 111, children: ... }, * ], * [ * { value: 1, children: ... }, * { value: 11, children: ... }, * { value: 111, children: ...} * ] * ] */
Traversal
We have support 3 kinds of common tree traversal methods: level-order(BFS), pre-order(DFS), post-order(DFS).
levelorder
levelordertree, // [[1], [2]]
preorder
preordertree, // [1, 2]
postorder
postordertree, // [2, 1]