UNPKG

917 BTypeScriptView Raw
1import { OrderByFieldConfs } from './orderBy'
2
3export interface ToArrayTreeOptions<T> {
4 strict?: boolean;
5 key?: string;
6 parentKey?: string;
7 children?: string;
8 mapChildren?: string;
9 sortKey?: OrderByFieldConfs<T, any>;
10 data?: string;
11 /**
12 * 已废弃,被 sortKey: { ...,order: 'desc' } 替换
13 * @deprecated
14 */
15 reverse?: boolean;
16}
17
18/**
19 * 将一个带层级的数据列表转成树结构
20 * @param {Array} list 数组
21 * @param {Object} options {strict: false, parentKey: 'parentId', key: 'id', children: 'children', mapChildren: '', data: 'data'}
22 */
23export declare function toArrayTree<T>(list: T[], options?: ToArrayTreeOptions<T>): T[];
24export declare function toArrayTree(list: any, options?: ToArrayTreeOptions<any>): any[];
25
26declare module './ctor' {
27 interface XEUtilsMethods {
28 toArrayTree: typeof toArrayTree;
29 }
30}
31
32export default toArrayTree