Skip to content

@pmun/utils / findTreeNode

Function: findTreeNode() ​

Call Signature ​

ts
function findTreeNode<T>(
   tree, 
   predicate, 
childKey?): undefined | TreeNode<T, "children">;

按数组顺序深度优先查找树节点,先检查当前节点,再查找子节点。

Type Parameters ​

T ​

T extends object

Parameters ​

tree ​

readonly TreeNode<T, "children">[]

根节点数组

predicate ​

(node) => boolean

判断当前节点是否匹配

childKey? ​

"children"

子节点的键名,默认为 children

Returns ​

undefined | TreeNode<T, "children">

首个匹配的原节点,未找到时返回 undefined

Example ​

ts
const menus = [{ id: 1, children: [{ id: 2 }] }]
findTreeNode(menus, node => node.id === 2) // { id: 2 }

const groups = [{ id: 1, items: [{ id: 2 }] }]
findTreeNode(groups, node => node.id === 2, 'items') // { id: 2 }

Call Signature ​

ts
function findTreeNode<T, K>(
   tree, 
   predicate, 
childKey): undefined | TreeNode<T, K>;

按数组顺序深度优先查找树节点,先检查当前节点,再查找子节点。

Type Parameters ​

T ​

T extends object

K ​

K extends string

Parameters ​

tree ​

readonly TreeNode<T, K>[]

根节点数组

predicate ​

(node) => boolean

判断当前节点是否匹配

childKey ​

K

子节点的键名,默认为 children

Returns ​

undefined | TreeNode<T, K>

首个匹配的原节点,未找到时返回 undefined

Example ​

ts
const menus = [{ id: 1, children: [{ id: 2 }] }]
findTreeNode(menus, node => node.id === 2) // { id: 2 }

const groups = [{ id: 1, items: [{ id: 2 }] }]
findTreeNode(groups, node => node.id === 2, 'items') // { id: 2 }