util-helpers/types/findTreeNode.d.ts

一个基于业务场景的工具方法库

/**
 * 查找树结构数据节点
 *
 * @alias module:Tree.findTreeNode
 * @since 4.14.0
 * @param {Object[]} tree 树结构数据
 * @param {function} predicate 遍历每一项执行的函数，参数是当前遍历到的节点数据，如果返回 `Truthy` ，将返回该节点
 * @param {string} [childrenField='children'] 子级字段名，默认`children`
 * @returns {Object|undefined}
 * @example
 * const menus = [{ id: '1', name: '首页', code: 'trade', pid: null }, { id: '2', name: '交易管理', code: 'trade', pid: null, children: [{ id: '3', name: '交易查询', code: 'trade-1', pid: '2', children: [{ id: '4', name: '交易查询-查询操作', code: 'trade-1-1', pid: '3' }]}]}, { id: '5', name: '权限管理', code: 'authorization', pid: null, children: [{ id: '6', name: '角色管理', code: 'authorization-1', pid: '5' }, { id: '7', name: '用户管理', code: 'authorization-2', pid: '5' }]}];
 *
 * findTreeNode(menus, item=>item.id === '2');
 * // {id: '2', name: '交易管理', code: 'trade', pid: null, children: [ { id: '3', name: '交易查询', code: 'trade-1', pid: '2', children: [{ id: '4', name: '交易查询-查询操作', code: 'trade-1-1', pid: '3' }]}]}
 *
 * findTreeNode(menus, item=>item.id === '7');
 * // { id: '7', name: '用户管理', code: 'authorization-2', pid: '5' }
 *
 * findTreeNode(menus, item=>item.id === 'not found');
 * // undefined
 */
declare function findTreeNode<T, F extends (item: T) => boolean>(tree: T[], predicate: F, childrenField?: string): T | undefined;
export default findTreeNode;