@cloudcome/utils-core 1.1.1 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -0
- package/dist/array.cjs +129 -0
- package/dist/array.cjs.map +1 -0
- package/dist/array.d.ts +171 -0
- package/dist/array.mjs +129 -0
- package/dist/array.mjs.map +1 -0
- package/dist/async.cjs +219 -0
- package/dist/async.cjs.map +1 -0
- package/dist/async.d.ts +137 -0
- package/dist/async.mjs +219 -0
- package/dist/async.mjs.map +1 -0
- package/dist/base64.cjs +16 -0
- package/dist/base64.cjs.map +1 -0
- package/dist/base64.d.ts +7 -0
- package/dist/base64.mjs +16 -0
- package/dist/base64.mjs.map +1 -0
- package/dist/cache.cjs +79 -0
- package/dist/cache.cjs.map +1 -0
- package/dist/cache.d.ts +90 -0
- package/dist/cache.mjs +79 -0
- package/dist/cache.mjs.map +1 -0
- package/{src/color/contrast.ts → dist/color/contrast.d.ts} +2 -12
- package/dist/color/distance.d.ts +8 -0
- package/dist/color/helpers.d.ts +2 -0
- package/dist/color/hex-hsl.d.ts +3 -0
- package/{src/color/hex-hsv.ts → dist/color/hex-hsv.d.ts} +3 -11
- package/{src/color/hex-hwb.ts → dist/color/hex-hwb.d.ts} +3 -11
- package/dist/color/hex-rgb.d.ts +18 -0
- package/{src/color/hsl-lighten.ts → dist/color/hsl-lighten.d.ts} +2 -7
- package/{src/color/hsv-brighten.ts → dist/color/hsv-brighten.d.ts} +2 -7
- package/{src/color/luminance.ts → dist/color/luminance.d.ts} +2 -9
- package/{src/color/mix.ts → dist/color/mix.d.ts} +2 -10
- package/dist/color/rgb-hsl.d.ts +23 -0
- package/{src/color/rgb-hsv.ts → dist/color/rgb-hsv.d.ts} +3 -30
- package/dist/color/rgb-hwb.d.ts +29 -0
- package/{src/color/rgb-lab.ts → dist/color/rgb-lab.d.ts} +3 -11
- package/dist/color/rgb-whiter.d.ts +12 -0
- package/dist/color/rgb-xyz.d.ts +22 -0
- package/{src/color/types.ts → dist/color/types.d.ts} +30 -12
- package/{src/color/xyz-lab.ts → dist/color/xyz-lab.d.ts} +3 -32
- package/dist/color.cjs +250 -0
- package/dist/color.cjs.map +1 -0
- package/dist/color.mjs +250 -0
- package/dist/color.mjs.map +1 -0
- package/dist/const.cjs +14 -0
- package/dist/const.cjs.map +1 -0
- package/dist/const.mjs +15 -0
- package/dist/const.mjs.map +1 -0
- package/dist/core.cjs +250 -0
- package/dist/core.cjs.map +1 -0
- package/dist/core.mjs +251 -0
- package/dist/core.mjs.map +1 -0
- package/dist/crypto/md5.d.mts +1 -0
- package/dist/crypto/sha1.d.mts +1 -0
- package/dist/crypto/sha256.d.mts +1 -0
- package/dist/crypto/sha512.d.mts +1 -0
- package/dist/crypto.cjs +812 -0
- package/dist/crypto.cjs.map +1 -0
- package/{src/crypto.ts → dist/crypto.d.ts} +4 -20
- package/dist/crypto.mjs +812 -0
- package/dist/crypto.mjs.map +1 -0
- package/dist/date/const.d.ts +6 -0
- package/dist/date/core.d.ts +52 -0
- package/dist/date/days.d.ts +23 -0
- package/{src/date/is.ts → dist/date/is.d.ts} +8 -102
- package/dist/date/relative.d.ts +44 -0
- package/dist/date/start-end.d.ts +73 -0
- package/dist/date/timezone.d.ts +67 -0
- package/dist/date/weeks.d.ts +72 -0
- package/dist/date.cjs +239 -0
- package/dist/date.cjs.map +1 -0
- package/dist/date.mjs +241 -0
- package/dist/date.mjs.map +1 -0
- package/dist/dict.cjs +2 -0
- package/dist/dict.cjs.map +1 -0
- package/dist/dict.mjs +2 -0
- package/dist/dict.mjs.map +1 -0
- package/dist/each.cjs +18 -0
- package/dist/each.cjs.map +1 -0
- package/dist/each.mjs +19 -0
- package/dist/each.mjs.map +1 -0
- package/dist/easing.cjs +151 -0
- package/dist/easing.cjs.map +1 -0
- package/dist/easing.d.ts +46 -0
- package/dist/easing.mjs +151 -0
- package/dist/easing.mjs.map +1 -0
- package/dist/emitter.cjs +94 -0
- package/dist/emitter.cjs.map +1 -0
- package/dist/emitter.d.ts +68 -0
- package/dist/emitter.mjs +94 -0
- package/dist/emitter.mjs.map +1 -0
- package/dist/enum.cjs +58 -0
- package/dist/enum.cjs.map +1 -0
- package/dist/enum.d.ts +68 -0
- package/dist/enum.mjs +58 -0
- package/dist/enum.mjs.map +1 -0
- package/dist/env.cjs +28 -0
- package/dist/env.cjs.map +1 -0
- package/{src/env.ts → dist/env.d.ts} +6 -30
- package/dist/env.mjs +28 -0
- package/dist/env.mjs.map +1 -0
- package/dist/error.cjs +12 -0
- package/dist/error.cjs.map +1 -0
- package/{src/error.ts → dist/error.d.ts} +3 -12
- package/dist/error.mjs +12 -0
- package/dist/error.mjs.map +1 -0
- package/dist/exception.cjs +22 -0
- package/dist/exception.cjs.map +1 -0
- package/dist/exception.d.ts +31 -0
- package/dist/exception.mjs +22 -0
- package/dist/exception.mjs.map +1 -0
- package/dist/fn.cjs +76 -0
- package/dist/fn.cjs.map +1 -0
- package/dist/fn.d.ts +102 -0
- package/dist/fn.mjs +76 -0
- package/dist/fn.mjs.map +1 -0
- package/dist/index.cjs +5 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.mjs +5 -0
- package/dist/index.mjs.map +1 -0
- package/dist/merge.cjs +87 -0
- package/dist/merge.cjs.map +1 -0
- package/dist/merge.mjs +88 -0
- package/dist/merge.mjs.map +1 -0
- package/dist/number.cjs +14 -0
- package/dist/number.cjs.map +1 -0
- package/dist/number.d.ts +153 -0
- package/dist/number.mjs +14 -0
- package/dist/number.mjs.map +1 -0
- package/{src/object/each.ts → dist/object/each.d.ts} +3 -23
- package/dist/object/get-set.d.ts +111 -0
- package/dist/object/is.d.ts +32 -0
- package/dist/object/merge.d.ts +72 -0
- package/{src/object/process.ts → dist/object/process.d.ts} +4 -38
- package/dist/object.cjs +130 -0
- package/dist/object.cjs.map +1 -0
- package/dist/object.mjs +130 -0
- package/dist/object.mjs.map +1 -0
- package/dist/path.cjs +77 -0
- package/dist/path.cjs.map +1 -0
- package/dist/path.d.ts +82 -0
- package/dist/path.mjs +77 -0
- package/dist/path.mjs.map +1 -0
- package/dist/promise.cjs +62 -0
- package/dist/promise.cjs.map +1 -0
- package/{src/promise.ts → dist/promise.d.ts} +6 -67
- package/dist/promise.mjs +62 -0
- package/dist/promise.mjs.map +1 -0
- package/dist/qs.cjs +47 -0
- package/dist/qs.cjs.map +1 -0
- package/{src/qs.ts → dist/qs.d.ts} +3 -60
- package/dist/qs.mjs +47 -0
- package/dist/qs.mjs.map +1 -0
- package/dist/regexp.cjs +66 -0
- package/dist/regexp.cjs.map +1 -0
- package/dist/regexp.d.ts +65 -0
- package/dist/regexp.mjs +66 -0
- package/dist/regexp.mjs.map +1 -0
- package/dist/string.cjs +16 -0
- package/dist/string.cjs.map +1 -0
- package/dist/string.d.ts +80 -0
- package/dist/string.mjs +16 -0
- package/dist/string.mjs.map +1 -0
- package/dist/string2.cjs +157 -0
- package/dist/string2.cjs.map +1 -0
- package/dist/string2.mjs +158 -0
- package/dist/string2.mjs.map +1 -0
- package/dist/time/from.d.ts +14 -0
- package/dist/time/to.d.ts +38 -0
- package/dist/time.cjs +82 -0
- package/dist/time.cjs.map +1 -0
- package/dist/time.mjs +82 -0
- package/dist/time.mjs.map +1 -0
- package/dist/timer.cjs +119 -0
- package/dist/timer.cjs.map +1 -0
- package/dist/timer.d.ts +96 -0
- package/{src/timer.ts → dist/timer.mjs} +17 -124
- package/dist/timer.mjs.map +1 -0
- package/dist/tree.cjs +125 -0
- package/dist/tree.cjs.map +1 -0
- package/dist/tree.d.ts +210 -0
- package/dist/tree.mjs +125 -0
- package/dist/tree.mjs.map +1 -0
- package/dist/type.cjs +78 -0
- package/dist/type.cjs.map +1 -0
- package/{src/type.ts → dist/type.d.ts} +20 -96
- package/dist/type.mjs +78 -0
- package/dist/type.mjs.map +1 -0
- package/dist/types.cjs +2 -0
- package/dist/types.cjs.map +1 -0
- package/{src/types.ts → dist/types.d.ts} +12 -33
- package/dist/types.mjs +2 -0
- package/dist/types.mjs.map +1 -0
- package/dist/unique.cjs +46 -0
- package/dist/unique.cjs.map +1 -0
- package/dist/unique.d.ts +22 -0
- package/dist/unique.mjs +46 -0
- package/dist/unique.mjs.map +1 -0
- package/dist/url.cjs +37 -0
- package/dist/url.cjs.map +1 -0
- package/dist/url.d.ts +53 -0
- package/dist/url.mjs +37 -0
- package/dist/url.mjs.map +1 -0
- package/dist/version.cjs +33 -0
- package/dist/version.cjs.map +1 -0
- package/dist/version.d.ts +32 -0
- package/dist/version.mjs +33 -0
- package/dist/version.mjs.map +1 -0
- package/package.json +8 -2
- package/CHANGELOG.md +0 -52
- package/src/array.ts +0 -312
- package/src/async.ts +0 -379
- package/src/base64.ts +0 -20
- package/src/cache.ts +0 -146
- package/src/color/distance.ts +0 -28
- package/src/color/helpers.ts +0 -23
- package/src/color/hex-hsl.ts +0 -11
- package/src/color/hex-rgb.ts +0 -39
- package/src/color/rgb-hsl.ts +0 -53
- package/src/color/rgb-hwb.ts +0 -56
- package/src/color/rgb-whiter.ts +0 -22
- package/src/color/rgb-xyz.ts +0 -62
- package/src/crypto/md5.mjs +0 -357
- package/src/crypto/sha1.mjs +0 -300
- package/src/crypto/sha256.mjs +0 -310
- package/src/crypto/sha512.mjs +0 -459
- package/src/date/const.ts +0 -6
- package/src/date/core.ts +0 -162
- package/src/date/days.ts +0 -51
- package/src/date/relative.ts +0 -92
- package/src/date/start-end.ts +0 -246
- package/src/date/timezone.ts +0 -220
- package/src/date/weeks.ts +0 -100
- package/src/dts/global.d.ts +0 -27
- package/src/easing.ts +0 -166
- package/src/emitter.ts +0 -117
- package/src/enum.ts +0 -171
- package/src/exception.ts +0 -68
- package/src/fn.ts +0 -197
- package/src/index.ts +0 -1
- package/src/number.ts +0 -236
- package/src/object/get-set.ts +0 -273
- package/src/object/is.ts +0 -128
- package/src/object/merge.ts +0 -180
- package/src/path.ts +0 -188
- package/src/regexp.ts +0 -156
- package/src/string.ts +0 -146
- package/src/time/from.ts +0 -57
- package/src/time/to.ts +0 -106
- package/src/tree.ts +0 -394
- package/src/unique.ts +0 -77
- package/src/url.ts +0 -93
- package/src/version.ts +0 -71
- package/test/array.test.ts +0 -332
- package/test/async-real.test.ts +0 -39
- package/test/async.test.ts +0 -375
- package/test/base64.test.ts +0 -32
- package/test/cache.test.ts +0 -83
- package/test/color.test.ts +0 -163
- package/test/crypto.test.ts +0 -34
- package/test/date-tz.test.ts +0 -206
- package/test/date.test.ts +0 -353
- package/test/easing.test.ts +0 -33
- package/test/emitter.test.ts +0 -71
- package/test/enum.test.ts +0 -113
- package/test/env.test.ts +0 -69
- package/test/error.test.ts +0 -58
- package/test/exception.test.ts +0 -43
- package/test/fn.test.ts +0 -263
- package/test/helpers.ts +0 -23
- package/test/index.test.ts +0 -6
- package/test/number.test.ts +0 -213
- package/test/object.test.ts +0 -309
- package/test/path.test.ts +0 -156
- package/test/promise.test.ts +0 -199
- package/test/qs.test.ts +0 -79
- package/test/regexp.test.ts +0 -97
- package/test/string.test.ts +0 -150
- package/test/time.test.ts +0 -214
- package/test/timer.test.ts +0 -114
- package/test/tree.test.ts +0 -348
- package/test/type.test.ts +0 -226
- package/test/unique.test.ts +0 -71
- package/test/url.test.ts +0 -136
- package/test/version.test.ts +0 -52
- package/tsconfig.json +0 -31
- package/vite.config.mts +0 -114
- /package/{src/color.ts → dist/color.d.ts} +0 -0
- /package/{src/date.ts → dist/date.d.ts} +0 -0
- /package/{src/dict.ts → dist/dict.d.ts} +0 -0
- /package/{src/object.ts → dist/object.d.ts} +0 -0
- /package/{src/time.ts → dist/time.d.ts} +0 -0
package/dist/tree.d.ts
ADDED
|
@@ -0,0 +1,210 @@
|
|
|
1
|
+
import { AnyObject } from './types';
|
|
2
|
+
/**
|
|
3
|
+
* 表示深度遍历中的节点对象,包含子节点列表。
|
|
4
|
+
*/
|
|
5
|
+
export type TreeItem = AnyObject & {
|
|
6
|
+
/**
|
|
7
|
+
* 子节点列表。
|
|
8
|
+
*/
|
|
9
|
+
children?: TreeItem[];
|
|
10
|
+
};
|
|
11
|
+
/**
|
|
12
|
+
* 表示深度遍历中的节点列表。
|
|
13
|
+
*
|
|
14
|
+
* @template I - 节点对象的类型,必须继承自 `TreeItem`。
|
|
15
|
+
*/
|
|
16
|
+
export type TreeList<I extends TreeItem> = I[];
|
|
17
|
+
/**
|
|
18
|
+
* 表示深度遍历中的遍历器状态。
|
|
19
|
+
*
|
|
20
|
+
* @template I - 节点对象的类型,必须继承自 `TreeItem`。
|
|
21
|
+
*/
|
|
22
|
+
export type TreeWalker<I extends TreeItem> = {
|
|
23
|
+
/**
|
|
24
|
+
* 当前层级的节点列表。
|
|
25
|
+
*/
|
|
26
|
+
list: TreeList<I>;
|
|
27
|
+
/**
|
|
28
|
+
* 当前节点的父节点,如果为根节点则为 `null`。
|
|
29
|
+
*/
|
|
30
|
+
parent: I | null;
|
|
31
|
+
/**
|
|
32
|
+
* 当前节点的层级,从 1 开始计数。
|
|
33
|
+
*/
|
|
34
|
+
level: number;
|
|
35
|
+
/**
|
|
36
|
+
* 从根节点到当前节点的路径。
|
|
37
|
+
*/
|
|
38
|
+
path: TreeList<I>;
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
* 表示深度遍历中的节点信息。
|
|
42
|
+
*
|
|
43
|
+
* @template I - 节点对象的类型,必须继承自 `TreeItem`。
|
|
44
|
+
*/
|
|
45
|
+
export type TreeInfo<I extends TreeItem> = TreeWalker<I> & {
|
|
46
|
+
/**
|
|
47
|
+
* 当前节点。
|
|
48
|
+
*/
|
|
49
|
+
item: I;
|
|
50
|
+
/**
|
|
51
|
+
* 当前节点在 `list` 中的索引。
|
|
52
|
+
*/
|
|
53
|
+
index: number;
|
|
54
|
+
};
|
|
55
|
+
/**
|
|
56
|
+
* 深度遍历的同步迭代器函数类型。
|
|
57
|
+
*
|
|
58
|
+
* @template I - 节点对象的类型,必须继承自 `TreeItem`。
|
|
59
|
+
* @param info - 当前节点的信息。
|
|
60
|
+
* @returns 如果返回 `false`,则提前终止遍历。
|
|
61
|
+
*/
|
|
62
|
+
export type TreeEachIterator<I extends TreeItem> = (info: TreeInfo<I>) => false | unknown;
|
|
63
|
+
/**
|
|
64
|
+
* 深度遍历的异步迭代器函数类型。
|
|
65
|
+
*
|
|
66
|
+
* @template I - 节点对象的类型,必须继承自 `TreeItem`。
|
|
67
|
+
* @param info - 当前节点的信息。
|
|
68
|
+
* @returns 如果返回 `false`,则提前终止遍历。
|
|
69
|
+
*/
|
|
70
|
+
export type TreeEachIteratorAsync<I extends TreeItem> = (info: TreeInfo<I>) => Promise<boolean | unknown>;
|
|
71
|
+
/**
|
|
72
|
+
* 深度遍历的同步遍历器函数类型。
|
|
73
|
+
*
|
|
74
|
+
* @template I - 节点对象的类型,必须继承自 `TreeItem`。
|
|
75
|
+
* @param walker - 遍历器状态。
|
|
76
|
+
* @returns 遍历结果。
|
|
77
|
+
*/
|
|
78
|
+
export type TreeWalk<I extends TreeItem> = (walker: TreeWalker<I>) => unknown;
|
|
79
|
+
/**
|
|
80
|
+
* 深度遍历的异步遍历器函数类型。
|
|
81
|
+
*
|
|
82
|
+
* @template I - 节点对象的类型,必须继承自 `TreeItem`。
|
|
83
|
+
* @param walker - 遍历器状态。
|
|
84
|
+
* @returns 异步遍历结果。
|
|
85
|
+
*/
|
|
86
|
+
export type TreeWalkAsync<I extends TreeItem> = (walker: TreeWalker<I>) => Promise<unknown>;
|
|
87
|
+
/**
|
|
88
|
+
* 深度遍历数组中的每个元素,并对每个元素执行提供的回调函数。
|
|
89
|
+
*
|
|
90
|
+
* @param treeList - 要遍历的深度数组。
|
|
91
|
+
* @param iterator - 对每个元素执行的回调函数。如果回调函数返回 `false`,则提前终止遍历。
|
|
92
|
+
* @param breadthFist - 是否使用广度优先遍历,默认为 `false`(深度优先)。
|
|
93
|
+
* @returns 无返回值。
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* ```typescript
|
|
97
|
+
* const treeList = [
|
|
98
|
+
* { value: 1, children: [{ value: 2 }, { value: 3 }] },
|
|
99
|
+
* { value: 4 }
|
|
100
|
+
* ];
|
|
101
|
+
*
|
|
102
|
+
* treeEach(treeList, (item) => {
|
|
103
|
+
* console.log(item.value);
|
|
104
|
+
* if (item.value === 2) return false; // 提前终止遍历
|
|
105
|
+
* });
|
|
106
|
+
* ```
|
|
107
|
+
*/
|
|
108
|
+
export declare function treeEach<I extends TreeItem = TreeItem>(treeList: TreeList<I>, iterator: TreeEachIterator<I>, breadthFist?: boolean): void;
|
|
109
|
+
/**
|
|
110
|
+
* 在深度数组中查找满足条件的第一个节点信息。
|
|
111
|
+
*
|
|
112
|
+
* @param treeList - 要查找的深度数组。
|
|
113
|
+
* @param predicate - 判断节点是否满足条件的回调函数。
|
|
114
|
+
* @param breadthFist - 是否使用广度优先查找,默认为 `false`(深度优先)。
|
|
115
|
+
* @returns 如果找到满足条件的节点,则返回该节点的信息;否则返回 `undefined`。
|
|
116
|
+
*
|
|
117
|
+
* @example
|
|
118
|
+
* ```typescript
|
|
119
|
+
* const treeList = [
|
|
120
|
+
* { value: 1, children: [{ value: 2 }, { value: 3 }] },
|
|
121
|
+
* { value: 4 }
|
|
122
|
+
* ];
|
|
123
|
+
*
|
|
124
|
+
* const found = treeFind(treeList, (info) => info.item.value === 3);
|
|
125
|
+
* console.log(found);
|
|
126
|
+
* // {
|
|
127
|
+
* // item: { value: 3 },
|
|
128
|
+
* // index: 1,
|
|
129
|
+
* // list: [{ value: 2 }, { value: 3 }],
|
|
130
|
+
* // parent: { value: 1, children: [{ value: 2 }, { value: 3 }] },
|
|
131
|
+
* // level: 2,
|
|
132
|
+
* // path: [{ value: 1, children: [{ value: 2 }, { value: 3 }] }, { value: 3 }]
|
|
133
|
+
* // }
|
|
134
|
+
* ```
|
|
135
|
+
*/
|
|
136
|
+
export declare function treeFind<I extends TreeItem>(treeList: TreeList<I>, predicate: (info: TreeInfo<I>) => boolean, breadthFist?: boolean): TreeInfo<I> | undefined;
|
|
137
|
+
/**
|
|
138
|
+
* 将深度嵌套的树形结构扁平化为一维数组,并对每个节点执行指定的转换函数。
|
|
139
|
+
*
|
|
140
|
+
* @template I - 树节点的类型,必须继承自 `TreeItem`。
|
|
141
|
+
* @template T - 转换后的数据类型。
|
|
142
|
+
* @param {TreeList<I>} deepList - 要扁平化的深度嵌套树形结构。
|
|
143
|
+
* @param {(info: TreeInfo<I>) => T} flatten - 对每个节点执行的转换函数,返回转换后的数据。
|
|
144
|
+
* @param {boolean} [breadthFist=false] - 是否使用广度优先遍历,默认为 `false`(深度优先)。
|
|
145
|
+
* @returns {T[]} - 转换后的一维数组。
|
|
146
|
+
* @example
|
|
147
|
+
* ```typescript
|
|
148
|
+
* const treeList = [
|
|
149
|
+
* { value: 1, children: [{ value: 2 }, { value: 3 }] },
|
|
150
|
+
* { value: 4 }
|
|
151
|
+
* ];
|
|
152
|
+
*
|
|
153
|
+
* const flattened = deepFlat(treeList, (info) => info.item.value);
|
|
154
|
+
* console.log(flattened); // [1, 2, 3, 4]
|
|
155
|
+
* ```
|
|
156
|
+
*/
|
|
157
|
+
export declare function deepFlat<I extends TreeItem, T>(deepList: TreeList<I>, flatten: (info: TreeInfo<I>) => T, breadthFist?: boolean): T[];
|
|
158
|
+
type FromItemInfo<I> = {
|
|
159
|
+
selfKey: unknown;
|
|
160
|
+
parentKey: unknown;
|
|
161
|
+
item: I;
|
|
162
|
+
index: number;
|
|
163
|
+
};
|
|
164
|
+
export type TreeFromOptions<I extends TreeItem> = {
|
|
165
|
+
getSelfKey: (item: I, index: number) => unknown;
|
|
166
|
+
getParentKey: (item: I, index: number) => unknown;
|
|
167
|
+
appendChild: (parentInfo: FromItemInfo<I>, info: FromItemInfo<I>) => unknown;
|
|
168
|
+
};
|
|
169
|
+
/**
|
|
170
|
+
* 从扁平列表构建树形结构。
|
|
171
|
+
*
|
|
172
|
+
* @template I - 节点对象的类型,必须继承自 `AnyObject`。
|
|
173
|
+
* @param {I[]} list - 扁平化的节点列表。
|
|
174
|
+
* @param {TreeFromOptions<I>} options - 构建树形结构的配置选项。
|
|
175
|
+
* @param {function} options.getSelfKey - 获取节点自身唯一标识的函数。
|
|
176
|
+
* @param {function} options.getParentKey - 获取节点父节点唯一标识的函数。
|
|
177
|
+
* @param {function} options.appendChild - 将子节点添加到父节点的函数。
|
|
178
|
+
* @returns {I | undefined} - 构建的树形结构的根节点,如果未找到根节点则返回 `undefined`。
|
|
179
|
+
*
|
|
180
|
+
* @example
|
|
181
|
+
* ```typescript
|
|
182
|
+
* const list = [
|
|
183
|
+
* { id: 1, parentId: null, name: 'Root' },
|
|
184
|
+
* { id: 2, parentId: 1, name: 'Child 1' },
|
|
185
|
+
* { id: 3, parentId: 1, name: 'Child 2' }
|
|
186
|
+
* ];
|
|
187
|
+
*
|
|
188
|
+
* const tree = treeFrom(list, {
|
|
189
|
+
* getSelfKey: (item) => item.id,
|
|
190
|
+
* getParentKey: (item) => item.parentId,
|
|
191
|
+
* appendChild: (parent, info) => {
|
|
192
|
+
* if (!parent.children) parent.children = [];
|
|
193
|
+
* parent.children.push(info.item);
|
|
194
|
+
* }
|
|
195
|
+
* });
|
|
196
|
+
*
|
|
197
|
+
* console.log(tree);
|
|
198
|
+
* // {
|
|
199
|
+
* // id: 1,
|
|
200
|
+
* // parentId: null,
|
|
201
|
+
* // name: 'Root',
|
|
202
|
+
* // children: [
|
|
203
|
+
* // { id: 2, parentId: 1, name: 'Child 1' },
|
|
204
|
+
* // { id: 3, parentId: 1, name: 'Child 2' }
|
|
205
|
+
* // ]
|
|
206
|
+
* // }
|
|
207
|
+
* ```
|
|
208
|
+
*/
|
|
209
|
+
export declare function treeFrom<I extends TreeItem>(list: I[], options: TreeFromOptions<I>): TreeList<I> | undefined;
|
|
210
|
+
export {};
|
package/dist/tree.mjs
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
import { arrayEach } from "./array.mjs";
|
|
2
|
+
import { isNullish, isUndefined, isArray } from "./type.mjs";
|
|
3
|
+
function treeEach(treeList, iterator, breadthFist = false) {
|
|
4
|
+
const treeInfoList = [];
|
|
5
|
+
let returnFalse = false;
|
|
6
|
+
const iterate = (info) => {
|
|
7
|
+
if (iterator(info) === false) {
|
|
8
|
+
returnFalse = true;
|
|
9
|
+
return false;
|
|
10
|
+
}
|
|
11
|
+
};
|
|
12
|
+
const next = (info, walk2) => {
|
|
13
|
+
const { item, level, parent, path } = info;
|
|
14
|
+
const { children } = item;
|
|
15
|
+
if (isArray(children)) {
|
|
16
|
+
returnFalse = walk2({
|
|
17
|
+
...info,
|
|
18
|
+
parent: item,
|
|
19
|
+
list: children,
|
|
20
|
+
level: level + 1
|
|
21
|
+
}) === false;
|
|
22
|
+
}
|
|
23
|
+
};
|
|
24
|
+
const walk = (walker) => {
|
|
25
|
+
const { list, level, parent, path } = walker;
|
|
26
|
+
const path2 = [...path];
|
|
27
|
+
while (parent !== null && path2.length > 0 && path2[path2.length - 1] !== parent) {
|
|
28
|
+
path2.pop();
|
|
29
|
+
}
|
|
30
|
+
arrayEach(list, (item, index) => {
|
|
31
|
+
if (returnFalse) return false;
|
|
32
|
+
const info = {
|
|
33
|
+
...walker,
|
|
34
|
+
item,
|
|
35
|
+
index,
|
|
36
|
+
path: [...path2, item]
|
|
37
|
+
};
|
|
38
|
+
if (breadthFist) {
|
|
39
|
+
treeInfoList.push(info);
|
|
40
|
+
} else {
|
|
41
|
+
iterate(info);
|
|
42
|
+
if (returnFalse) return false;
|
|
43
|
+
next(info, walk);
|
|
44
|
+
}
|
|
45
|
+
});
|
|
46
|
+
if (breadthFist) {
|
|
47
|
+
while (!returnFalse) {
|
|
48
|
+
const info = treeInfoList.shift();
|
|
49
|
+
if (!info) break;
|
|
50
|
+
iterate(info);
|
|
51
|
+
if (returnFalse) break;
|
|
52
|
+
next(info, walk);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
return !returnFalse;
|
|
56
|
+
};
|
|
57
|
+
walk({
|
|
58
|
+
list: treeList,
|
|
59
|
+
level: 1,
|
|
60
|
+
parent: null,
|
|
61
|
+
path: []
|
|
62
|
+
});
|
|
63
|
+
}
|
|
64
|
+
function treeFind(treeList, predicate, breadthFist = false) {
|
|
65
|
+
let found;
|
|
66
|
+
treeEach(
|
|
67
|
+
treeList,
|
|
68
|
+
(info) => {
|
|
69
|
+
if (predicate(info)) {
|
|
70
|
+
found = info;
|
|
71
|
+
return false;
|
|
72
|
+
}
|
|
73
|
+
},
|
|
74
|
+
breadthFist
|
|
75
|
+
);
|
|
76
|
+
return found;
|
|
77
|
+
}
|
|
78
|
+
function deepFlat(deepList, flatten, breadthFist = false) {
|
|
79
|
+
const list2 = [];
|
|
80
|
+
treeEach(
|
|
81
|
+
deepList,
|
|
82
|
+
(info) => {
|
|
83
|
+
list2.push(flatten(info));
|
|
84
|
+
},
|
|
85
|
+
breadthFist
|
|
86
|
+
);
|
|
87
|
+
return list2;
|
|
88
|
+
}
|
|
89
|
+
function treeFrom(list, options) {
|
|
90
|
+
const keyMap = /* @__PURE__ */ new Map();
|
|
91
|
+
const freeSet = /* @__PURE__ */ new Set();
|
|
92
|
+
const roots = [];
|
|
93
|
+
const assign = (info, isFirst = false) => {
|
|
94
|
+
const { selfKey, parentKey, item, index } = info;
|
|
95
|
+
if (isNullish(parentKey)) {
|
|
96
|
+
roots.push(item);
|
|
97
|
+
} else {
|
|
98
|
+
const parent = keyMap.get(parentKey);
|
|
99
|
+
if (isUndefined(parent)) {
|
|
100
|
+
if (isFirst) freeSet.add(info);
|
|
101
|
+
} else {
|
|
102
|
+
options.appendChild(parent, info);
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
};
|
|
106
|
+
arrayEach(list, (item, index) => {
|
|
107
|
+
const selfKey = options.getSelfKey(item, index);
|
|
108
|
+
const parentKey = options.getParentKey(item, index);
|
|
109
|
+
if (isNullish(selfKey)) return;
|
|
110
|
+
const info = { selfKey, parentKey, item, index };
|
|
111
|
+
keyMap.set(selfKey, info);
|
|
112
|
+
assign(info, true);
|
|
113
|
+
});
|
|
114
|
+
for (const info of freeSet.values()) {
|
|
115
|
+
assign(info);
|
|
116
|
+
}
|
|
117
|
+
return roots;
|
|
118
|
+
}
|
|
119
|
+
export {
|
|
120
|
+
deepFlat,
|
|
121
|
+
treeEach,
|
|
122
|
+
treeFind,
|
|
123
|
+
treeFrom
|
|
124
|
+
};
|
|
125
|
+
//# sourceMappingURL=tree.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tree.mjs","sources":["../src/tree.ts"],"sourcesContent":["import { arrayEach } from './array';\nimport { isArray, isNullish, isUndefined } from './type';\nimport type { AnyObject } from './types';\n\n/**\n * 表示深度遍历中的节点对象,包含子节点列表。\n */\nexport type TreeItem = AnyObject & {\n /**\n * 子节点列表。\n */\n children?: TreeItem[];\n};\n\n/**\n * 表示深度遍历中的节点列表。\n *\n * @template I - 节点对象的类型,必须继承自 `TreeItem`。\n */\nexport type TreeList<I extends TreeItem> = I[];\n\n/**\n * 表示深度遍历中的遍历器状态。\n *\n * @template I - 节点对象的类型,必须继承自 `TreeItem`。\n */\nexport type TreeWalker<I extends TreeItem> = {\n /**\n * 当前层级的节点列表。\n */\n list: TreeList<I>;\n\n /**\n * 当前节点的父节点,如果为根节点则为 `null`。\n */\n parent: I | null;\n\n /**\n * 当前节点的层级,从 1 开始计数。\n */\n level: number;\n\n /**\n * 从根节点到当前节点的路径。\n */\n path: TreeList<I>;\n};\n\n/**\n * 表示深度遍历中的节点信息。\n *\n * @template I - 节点对象的类型,必须继承自 `TreeItem`。\n */\nexport type TreeInfo<I extends TreeItem> = TreeWalker<I> & {\n /**\n * 当前节点。\n */\n item: I;\n\n /**\n * 当前节点在 `list` 中的索引。\n */\n index: number;\n};\n\n/**\n * 深度遍历的同步迭代器函数类型。\n *\n * @template I - 节点对象的类型,必须继承自 `TreeItem`。\n * @param info - 当前节点的信息。\n * @returns 如果返回 `false`,则提前终止遍历。\n */\nexport type TreeEachIterator<I extends TreeItem> = (info: TreeInfo<I>) => false | unknown;\n\n/**\n * 深度遍历的异步迭代器函数类型。\n *\n * @template I - 节点对象的类型,必须继承自 `TreeItem`。\n * @param info - 当前节点的信息。\n * @returns 如果返回 `false`,则提前终止遍历。\n */\nexport type TreeEachIteratorAsync<I extends TreeItem> = (info: TreeInfo<I>) => Promise<boolean | unknown>;\n\n/**\n * 深度遍历的同步遍历器函数类型。\n *\n * @template I - 节点对象的类型,必须继承自 `TreeItem`。\n * @param walker - 遍历器状态。\n * @returns 遍历结果。\n */\nexport type TreeWalk<I extends TreeItem> = (walker: TreeWalker<I>) => unknown;\n\n/**\n * 深度遍历的异步遍历器函数类型。\n *\n * @template I - 节点对象的类型,必须继承自 `TreeItem`。\n * @param walker - 遍历器状态。\n * @returns 异步遍历结果。\n */\nexport type TreeWalkAsync<I extends TreeItem> = (walker: TreeWalker<I>) => Promise<unknown>;\n\n/**\n * 深度遍历数组中的每个元素,并对每个元素执行提供的回调函数。\n *\n * @param treeList - 要遍历的深度数组。\n * @param iterator - 对每个元素执行的回调函数。如果回调函数返回 `false`,则提前终止遍历。\n * @param breadthFist - 是否使用广度优先遍历,默认为 `false`(深度优先)。\n * @returns 无返回值。\n *\n * @example\n * ```typescript\n * const treeList = [\n * { value: 1, children: [{ value: 2 }, { value: 3 }] },\n * { value: 4 }\n * ];\n *\n * treeEach(treeList, (item) => {\n * console.log(item.value);\n * if (item.value === 2) return false; // 提前终止遍历\n * });\n * ```\n */\nexport function treeEach<I extends TreeItem = TreeItem>(\n treeList: TreeList<I>,\n iterator: TreeEachIterator<I>,\n breadthFist = false,\n): void {\n const treeInfoList: TreeInfo<I>[] = [];\n let returnFalse = false;\n\n const iterate = (info: TreeInfo<I>) => {\n if (iterator(info) === false) {\n returnFalse = true;\n return false;\n }\n };\n\n const next = (info: TreeInfo<I>, walk: TreeWalk<I>) => {\n const { item, level, parent, path } = info;\n const { children } = item;\n\n if (isArray(children)) {\n returnFalse =\n walk({\n ...info,\n parent: item,\n list: children as TreeList<I>,\n level: level + 1,\n }) === false;\n }\n };\n\n const walk: TreeWalk<I> = (walker) => {\n const { list, level, parent, path } = walker;\n\n const path2 = [...path];\n while (parent !== null && path2.length > 0 && path2[path2.length - 1] !== parent) {\n path2.pop();\n }\n\n arrayEach(list, (item, index) => {\n if (returnFalse) return false;\n\n const info: TreeInfo<I> = {\n ...walker,\n item,\n index,\n path: [...path2, item],\n };\n\n // 广度优先\n if (breadthFist) {\n treeInfoList.push(info);\n }\n // 深度优先\n else {\n iterate(info);\n if (returnFalse) return false;\n next(info, walk);\n }\n });\n\n if (breadthFist) {\n while (!returnFalse) {\n const info = treeInfoList.shift();\n if (!info) break;\n\n iterate(info);\n if (returnFalse) break;\n\n // 内部也会进入 walk\n next(info, walk);\n }\n }\n\n return !returnFalse;\n };\n\n walk({\n list: treeList,\n level: 1,\n parent: null,\n path: [],\n });\n}\n\n/**\n * 在深度数组中查找满足条件的第一个节点信息。\n *\n * @param treeList - 要查找的深度数组。\n * @param predicate - 判断节点是否满足条件的回调函数。\n * @param breadthFist - 是否使用广度优先查找,默认为 `false`(深度优先)。\n * @returns 如果找到满足条件的节点,则返回该节点的信息;否则返回 `undefined`。\n *\n * @example\n * ```typescript\n * const treeList = [\n * { value: 1, children: [{ value: 2 }, { value: 3 }] },\n * { value: 4 }\n * ];\n *\n * const found = treeFind(treeList, (info) => info.item.value === 3);\n * console.log(found);\n * // {\n * // item: { value: 3 },\n * // index: 1,\n * // list: [{ value: 2 }, { value: 3 }],\n * // parent: { value: 1, children: [{ value: 2 }, { value: 3 }] },\n * // level: 2,\n * // path: [{ value: 1, children: [{ value: 2 }, { value: 3 }] }, { value: 3 }]\n * // }\n * ```\n */\nexport function treeFind<I extends TreeItem>(\n treeList: TreeList<I>,\n predicate: (info: TreeInfo<I>) => boolean,\n breadthFist = false,\n): TreeInfo<I> | undefined {\n let found: TreeInfo<I> | undefined;\n\n treeEach(\n treeList,\n (info) => {\n if (predicate(info)) {\n found = info;\n return false;\n }\n },\n breadthFist,\n );\n\n return found;\n}\n\n/**\n * 将深度嵌套的树形结构扁平化为一维数组,并对每个节点执行指定的转换函数。\n *\n * @template I - 树节点的类型,必须继承自 `TreeItem`。\n * @template T - 转换后的数据类型。\n * @param {TreeList<I>} deepList - 要扁平化的深度嵌套树形结构。\n * @param {(info: TreeInfo<I>) => T} flatten - 对每个节点执行的转换函数,返回转换后的数据。\n * @param {boolean} [breadthFist=false] - 是否使用广度优先遍历,默认为 `false`(深度优先)。\n * @returns {T[]} - 转换后的一维数组。\n * @example\n * ```typescript\n * const treeList = [\n * { value: 1, children: [{ value: 2 }, { value: 3 }] },\n * { value: 4 }\n * ];\n *\n * const flattened = deepFlat(treeList, (info) => info.item.value);\n * console.log(flattened); // [1, 2, 3, 4]\n * ```\n */\nexport function deepFlat<I extends TreeItem, T>(\n deepList: TreeList<I>,\n flatten: (info: TreeInfo<I>) => T,\n breadthFist = false,\n): T[] {\n const list2: T[] = [];\n\n treeEach(\n deepList,\n (info) => {\n list2.push(flatten(info));\n },\n breadthFist,\n );\n\n return list2;\n}\n\ntype FromItemInfo<I> = {\n selfKey: unknown;\n parentKey: unknown;\n item: I;\n index: number;\n};\n\nexport type TreeFromOptions<I extends TreeItem> = {\n getSelfKey: (item: I, index: number) => unknown;\n getParentKey: (item: I, index: number) => unknown;\n appendChild: (parentInfo: FromItemInfo<I>, info: FromItemInfo<I>) => unknown;\n};\n\n/**\n * 从扁平列表构建树形结构。\n *\n * @template I - 节点对象的类型,必须继承自 `AnyObject`。\n * @param {I[]} list - 扁平化的节点列表。\n * @param {TreeFromOptions<I>} options - 构建树形结构的配置选项。\n * @param {function} options.getSelfKey - 获取节点自身唯一标识的函数。\n * @param {function} options.getParentKey - 获取节点父节点唯一标识的函数。\n * @param {function} options.appendChild - 将子节点添加到父节点的函数。\n * @returns {I | undefined} - 构建的树形结构的根节点,如果未找到根节点则返回 `undefined`。\n *\n * @example\n * ```typescript\n * const list = [\n * { id: 1, parentId: null, name: 'Root' },\n * { id: 2, parentId: 1, name: 'Child 1' },\n * { id: 3, parentId: 1, name: 'Child 2' }\n * ];\n *\n * const tree = treeFrom(list, {\n * getSelfKey: (item) => item.id,\n * getParentKey: (item) => item.parentId,\n * appendChild: (parent, info) => {\n * if (!parent.children) parent.children = [];\n * parent.children.push(info.item);\n * }\n * });\n *\n * console.log(tree);\n * // {\n * // id: 1,\n * // parentId: null,\n * // name: 'Root',\n * // children: [\n * // { id: 2, parentId: 1, name: 'Child 1' },\n * // { id: 3, parentId: 1, name: 'Child 2' }\n * // ]\n * // }\n * ```\n */\nexport function treeFrom<I extends TreeItem>(list: I[], options: TreeFromOptions<I>): TreeList<I> | undefined {\n const keyMap = new Map<unknown, FromItemInfo<I>>();\n const freeSet = new Set<FromItemInfo<I>>();\n const roots: TreeList<I> = [];\n\n // 分配节点\n const assign = (info: FromItemInfo<I>, isFirst = false) => {\n const { selfKey, parentKey, item, index } = info;\n\n // 父级指向为空\n if (isNullish(parentKey)) {\n roots.push(item);\n }\n // 父级指向不为空\n else {\n const parent = keyMap.get(parentKey);\n\n // 未找到父级节点\n if (isUndefined(parent)) {\n // 游离节点\n if (isFirst) freeSet.add(info);\n }\n // 已找到父级节点\n else {\n options.appendChild(parent, info);\n }\n }\n };\n\n // 构建 map\n arrayEach(list, (item, index) => {\n const selfKey = options.getSelfKey(item, index);\n const parentKey = options.getParentKey(item, index);\n\n if (isNullish(selfKey)) return;\n\n const info = { selfKey, parentKey, item, index };\n keyMap.set(selfKey, info);\n\n assign(info, true);\n });\n\n // 处理游离节点\n for (const info of freeSet.values()) {\n assign(info);\n }\n\n return roots;\n}\n"],"names":["walk"],"mappings":";;AA0HO,SAAS,SACd,UACA,UACA,cAAc,OACR;AACN,QAAM,eAA8B,CAAC;AACrC,MAAI,cAAc;AAEZ,QAAA,UAAU,CAAC,SAAsB;AACjC,QAAA,SAAS,IAAI,MAAM,OAAO;AACd,oBAAA;AACP,aAAA;AAAA,IAAA;AAAA,EAEX;AAEM,QAAA,OAAO,CAAC,MAAmBA,UAAsB;AACrD,UAAM,EAAE,MAAM,OAAO,QAAQ,KAAS,IAAA;AAChC,UAAA,EAAE,aAAa;AAEjB,QAAA,QAAQ,QAAQ,GAAG;AACrB,oBACEA,MAAK;AAAA,QACH,GAAG;AAAA,QACH,QAAQ;AAAA,QACR,MAAM;AAAA,QACN,OAAO,QAAQ;AAAA,MAChB,CAAA,MAAM;AAAA,IAAA;AAAA,EAEb;AAEM,QAAA,OAAoB,CAAC,WAAW;AACpC,UAAM,EAAE,MAAM,OAAO,QAAQ,KAAS,IAAA;AAEhC,UAAA,QAAQ,CAAC,GAAG,IAAI;AACf,WAAA,WAAW,QAAQ,MAAM,SAAS,KAAK,MAAM,MAAM,SAAS,CAAC,MAAM,QAAQ;AAChF,YAAM,IAAI;AAAA,IAAA;AAGF,cAAA,MAAM,CAAC,MAAM,UAAU;AAC/B,UAAI,YAAoB,QAAA;AAExB,YAAM,OAAoB;AAAA,QACxB,GAAG;AAAA,QACH;AAAA,QACA;AAAA,QACA,MAAM,CAAC,GAAG,OAAO,IAAI;AAAA,MACvB;AAGA,UAAI,aAAa;AACf,qBAAa,KAAK,IAAI;AAAA,MAAA,OAGnB;AACH,gBAAQ,IAAI;AACZ,YAAI,YAAoB,QAAA;AACxB,aAAK,MAAM,IAAI;AAAA,MAAA;AAAA,IACjB,CACD;AAED,QAAI,aAAa;AACf,aAAO,CAAC,aAAa;AACb,cAAA,OAAO,aAAa,MAAM;AAChC,YAAI,CAAC,KAAM;AAEX,gBAAQ,IAAI;AACZ,YAAI,YAAa;AAGjB,aAAK,MAAM,IAAI;AAAA,MAAA;AAAA,IACjB;AAGF,WAAO,CAAC;AAAA,EACV;AAEK,OAAA;AAAA,IACH,MAAM;AAAA,IACN,OAAO;AAAA,IACP,QAAQ;AAAA,IACR,MAAM,CAAA;AAAA,EAAC,CACR;AACH;AA6BO,SAAS,SACd,UACA,WACA,cAAc,OACW;AACrB,MAAA;AAEJ;AAAA,IACE;AAAA,IACA,CAAC,SAAS;AACJ,UAAA,UAAU,IAAI,GAAG;AACX,gBAAA;AACD,eAAA;AAAA,MAAA;AAAA,IAEX;AAAA,IACA;AAAA,EACF;AAEO,SAAA;AACT;AAsBO,SAAS,SACd,UACA,SACA,cAAc,OACT;AACL,QAAM,QAAa,CAAC;AAEpB;AAAA,IACE;AAAA,IACA,CAAC,SAAS;AACF,YAAA,KAAK,QAAQ,IAAI,CAAC;AAAA,IAC1B;AAAA,IACA;AAAA,EACF;AAEO,SAAA;AACT;AAuDgB,SAAA,SAA6B,MAAW,SAAsD;AACtG,QAAA,6BAAa,IAA8B;AAC3C,QAAA,8BAAc,IAAqB;AACzC,QAAM,QAAqB,CAAC;AAG5B,QAAM,SAAS,CAAC,MAAuB,UAAU,UAAU;AACzD,UAAM,EAAE,SAAS,WAAW,MAAM,MAAU,IAAA;AAGxC,QAAA,UAAU,SAAS,GAAG;AACxB,YAAM,KAAK,IAAI;AAAA,IAAA,OAGZ;AACG,YAAA,SAAS,OAAO,IAAI,SAAS;AAG/B,UAAA,YAAY,MAAM,GAAG;AAEnB,YAAA,QAAiB,SAAA,IAAI,IAAI;AAAA,MAAA,OAG1B;AACK,gBAAA,YAAY,QAAQ,IAAI;AAAA,MAAA;AAAA,IAClC;AAAA,EAEJ;AAGU,YAAA,MAAM,CAAC,MAAM,UAAU;AAC/B,UAAM,UAAU,QAAQ,WAAW,MAAM,KAAK;AAC9C,UAAM,YAAY,QAAQ,aAAa,MAAM,KAAK;AAE9C,QAAA,UAAU,OAAO,EAAG;AAExB,UAAM,OAAO,EAAE,SAAS,WAAW,MAAM,MAAM;AACxC,WAAA,IAAI,SAAS,IAAI;AAExB,WAAO,MAAM,IAAI;AAAA,EAAA,CAClB;AAGU,aAAA,QAAQ,QAAQ,UAAU;AACnC,WAAO,IAAI;AAAA,EAAA;AAGN,SAAA;AACT;"}
|
package/dist/type.cjs
ADDED
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
3
|
+
function typeIs(unknown) {
|
|
4
|
+
return Object.prototype.toString.call(unknown).slice(8, -1).toLowerCase();
|
|
5
|
+
}
|
|
6
|
+
function isString(unknown) {
|
|
7
|
+
return typeof unknown === "string";
|
|
8
|
+
}
|
|
9
|
+
function isBoolean(unknown) {
|
|
10
|
+
return typeof unknown === "boolean";
|
|
11
|
+
}
|
|
12
|
+
function isSymbol(unknown) {
|
|
13
|
+
return typeof unknown === "symbol";
|
|
14
|
+
}
|
|
15
|
+
function isBigInt(unknown) {
|
|
16
|
+
return typeof unknown === "bigint";
|
|
17
|
+
}
|
|
18
|
+
function isNumber(unknown) {
|
|
19
|
+
return typeof unknown === "number" && !Number.isNaN(unknown);
|
|
20
|
+
}
|
|
21
|
+
function isUndefined(unknown) {
|
|
22
|
+
return typeof unknown === "undefined";
|
|
23
|
+
}
|
|
24
|
+
function isVoid(unknown) {
|
|
25
|
+
return isUndefined(unknown);
|
|
26
|
+
}
|
|
27
|
+
function isNever(unknown) {
|
|
28
|
+
}
|
|
29
|
+
function isNull(unknown) {
|
|
30
|
+
return unknown === null;
|
|
31
|
+
}
|
|
32
|
+
function isNullish(unknown) {
|
|
33
|
+
return isNull(unknown) || isUndefined(unknown) || isVoid(unknown);
|
|
34
|
+
}
|
|
35
|
+
function isPrimitive(unknown) {
|
|
36
|
+
return isNull(unknown) || !(typeof unknown === "object" || typeof unknown === "function");
|
|
37
|
+
}
|
|
38
|
+
function isObject(unknown) {
|
|
39
|
+
return typeIs(unknown) === "object";
|
|
40
|
+
}
|
|
41
|
+
function isArray(unknown) {
|
|
42
|
+
return Array.isArray(unknown);
|
|
43
|
+
}
|
|
44
|
+
function isFunction(unknown) {
|
|
45
|
+
return typeof unknown === "function";
|
|
46
|
+
}
|
|
47
|
+
function isAsyncFunction(unknown) {
|
|
48
|
+
return isFunction(unknown) && unknown.constructor.name === "AsyncFunction";
|
|
49
|
+
}
|
|
50
|
+
function isError(unknown) {
|
|
51
|
+
return unknown instanceof Error;
|
|
52
|
+
}
|
|
53
|
+
function isPromise(unknown) {
|
|
54
|
+
return typeIs(unknown) === "promise";
|
|
55
|
+
}
|
|
56
|
+
function isDate(unknown) {
|
|
57
|
+
return unknown instanceof Date;
|
|
58
|
+
}
|
|
59
|
+
exports.isArray = isArray;
|
|
60
|
+
exports.isAsyncFunction = isAsyncFunction;
|
|
61
|
+
exports.isBigInt = isBigInt;
|
|
62
|
+
exports.isBoolean = isBoolean;
|
|
63
|
+
exports.isDate = isDate;
|
|
64
|
+
exports.isError = isError;
|
|
65
|
+
exports.isFunction = isFunction;
|
|
66
|
+
exports.isNever = isNever;
|
|
67
|
+
exports.isNull = isNull;
|
|
68
|
+
exports.isNullish = isNullish;
|
|
69
|
+
exports.isNumber = isNumber;
|
|
70
|
+
exports.isObject = isObject;
|
|
71
|
+
exports.isPrimitive = isPrimitive;
|
|
72
|
+
exports.isPromise = isPromise;
|
|
73
|
+
exports.isString = isString;
|
|
74
|
+
exports.isSymbol = isSymbol;
|
|
75
|
+
exports.isUndefined = isUndefined;
|
|
76
|
+
exports.isVoid = isVoid;
|
|
77
|
+
exports.typeIs = typeIs;
|
|
78
|
+
//# sourceMappingURL=type.cjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"type.cjs","sources":["../src/type.ts"],"sourcesContent":["import type { AnyArray, AnyAsyncFunction, AnyFunction, AnyObject } from './types';\n\n/**\n * 获取未知类型的类型名称\n * @param unknown - 未知类型的值\n * @returns 类型名称字符串\n */\nexport function typeIs(\n unknown: unknown,\n):\n | 'string'\n | 'number'\n | 'boolean'\n | 'object'\n | 'array'\n | 'function'\n | 'null'\n | 'undefined'\n | 'symbol'\n | 'bigint'\n | 'error'\n | 'promise'\n | string {\n return Object.prototype.toString.call(unknown).slice(8, -1).toLowerCase();\n}\n\n/**\n * 检查值是否为字符串\n * @param unknown - 未知类型的值\n * @returns 如果值为字符串则返回 true,否则返回 false\n */\nexport function isString(unknown: unknown): unknown is string {\n return typeof unknown === 'string';\n}\n\n/**\n * 检查值是否为布尔值\n * @param unknown - 未知类型的值\n * @returns 如果值为布尔值则返回 true,否则返回 false\n */\nexport function isBoolean(unknown: unknown): unknown is boolean {\n return typeof unknown === 'boolean';\n}\n\n/**\n * 检查值是否为符号\n * @param unknown - 未知类型的值\n * @returns 如果值为符号则返回 true,否则返回 false\n */\nexport function isSymbol(unknown: unknown): unknown is symbol {\n return typeof unknown === 'symbol';\n}\n\n/**\n * 检查值是否为大整数\n * @param unknown - 未知类型的值\n * @returns 如果值为大整数则返回 true,否则返回 false\n */\nexport function isBigInt(unknown: unknown): unknown is bigint {\n return typeof unknown === 'bigint';\n}\n\n/**\n * 检查值是否为数字\n * @param unknown - 未知类型的值\n * @returns 如果值为数字且不是 NaN 则返回 true,否则返回 false\n */\nexport function isNumber(unknown: unknown): unknown is number {\n return typeof unknown === 'number' && !Number.isNaN(unknown);\n}\n\n/**\n * 检查值是否为 undefined\n * @param unknown - 未知类型的值\n * @returns 如果值为 undefined 则返回 true,否则返回 false\n */\nexport function isUndefined(unknown: unknown): unknown is undefined {\n return typeof unknown === 'undefined';\n}\n\n/**\n * 检查值是否为 void\n * @param unknown - 未知类型的值\n * @returns 如果值为 undefined 则返回 true,否则返回 false\n */\n// biome-ignore lint/suspicious/noConfusingVoidType: <explanation>\nexport function isVoid(unknown: unknown): unknown is void {\n return isUndefined(unknown);\n}\n\n/**\n * 永不执行,用于 switch-case/if-else 类型断言\n * @param unknown - 永远不会执行的值\n */\nexport function isNever(unknown: never) {\n //\n}\n\n/**\n * 检查值是否为 null\n * @param unknown - 未知类型的值\n * @returns 如果值为 null 则返回 true,否则返回 false\n */\nexport function isNull(unknown: unknown): unknown is null {\n return unknown === null;\n}\n\n/**\n * 检查值是否为 nullish(null 或 undefined 或 void)\n * @param unknown - 未知类型的值\n * @returns 如果值为 null 或 undefined 或 void 则返回 true,否则返回 false\n */\n// biome-ignore lint/suspicious/noConfusingVoidType: <explanation>\nexport function isNullish(unknown: unknown): unknown is null | undefined | void {\n return isNull(unknown) || isUndefined(unknown) || isVoid(unknown);\n}\n\n/**\n * 检查值是否为原始类型(null 或 非对象)\n * @param unknown - 未知类型的值\n * @returns 如果值为原始类型则返回 true,否则返回 false\n */\nexport function isPrimitive(\n unknown: unknown,\n): unknown is string | number | boolean | symbol | bigint | null | undefined {\n return isNull(unknown) || !(typeof unknown === 'object' || typeof unknown === 'function');\n}\n\n/**\n * 检查值是否为对象,但要注意,此时的对象类型是包含了数组和函数\n * @param unknown - 未知类型的值\n * @returns 如果值为对象则返回 true,否则返回 false\n */\nexport function isObject(unknown: unknown): unknown is AnyObject {\n return typeIs(unknown) === 'object';\n}\n\n/**\n * 检查值是否为数组\n * @param unknown - 未知类型的值\n * @returns 如果值为数组则返回 true,否则返回 false\n */\nexport function isArray(unknown: unknown): unknown is AnyArray {\n return Array.isArray(unknown);\n}\n\n/**\n * 检查值是否为函数\n * @param unknown - 未知类型的值\n * @returns 如果值为函数则返回 true,否则返回 false\n */\nexport function isFunction(unknown: unknown): unknown is AnyFunction {\n return typeof unknown === 'function';\n}\n\n/**\n * 检查值是否为异步函数\n * @param unknown - 需要检查的值\n * @returns 如果值为异步函数则返回 true,否则返回 false\n * @example\n * ```typescript\n * async function example() {}\n *\n * isAsyncFunction(example); // true\n * isAsyncFunction(() => {}); // false\n * ```\n */\nexport function isAsyncFunction(unknown: unknown): unknown is AnyAsyncFunction {\n return isFunction(unknown) && unknown.constructor.name === 'AsyncFunction';\n}\n\n/**\n * 检查值是否为 Error 类型\n * @param unknown - 未知类型的值\n * @returns 如果值为 Error 类型则返回 true,否则返回 false\n */\nexport function isError(unknown: unknown): unknown is Error {\n return unknown instanceof Error;\n}\n\n/**\n * 检查值是否为 Promise 类型\n * @param unknown - 未知类型的值\n * @returns 如果值为 Promise 类型则返回 true,否则返回 false\n */\nexport function isPromise<T>(unknown: unknown): unknown is Promise<T> {\n return typeIs(unknown) === 'promise';\n}\n\n/**\n * 检查值是否为 Date 类型\n * @param unknown - 未知类型的值\n * @returns 如果值为 Date 类型则返回 true,否则返回 false\n */\nexport function isDate(unknown: unknown): unknown is Date {\n return unknown instanceof Date;\n}\n"],"names":[],"mappings":";;AAOO,SAAS,OACd,SAcS;AACF,SAAA,OAAO,UAAU,SAAS,KAAK,OAAO,EAAE,MAAM,GAAG,EAAE,EAAE,YAAY;AAC1E;AAOO,SAAS,SAAS,SAAqC;AAC5D,SAAO,OAAO,YAAY;AAC5B;AAOO,SAAS,UAAU,SAAsC;AAC9D,SAAO,OAAO,YAAY;AAC5B;AAOO,SAAS,SAAS,SAAqC;AAC5D,SAAO,OAAO,YAAY;AAC5B;AAOO,SAAS,SAAS,SAAqC;AAC5D,SAAO,OAAO,YAAY;AAC5B;AAOO,SAAS,SAAS,SAAqC;AAC5D,SAAO,OAAO,YAAY,YAAY,CAAC,OAAO,MAAM,OAAO;AAC7D;AAOO,SAAS,YAAY,SAAwC;AAClE,SAAO,OAAO,YAAY;AAC5B;AAQO,SAAS,OAAO,SAAmC;AACxD,SAAO,YAAY,OAAO;AAC5B;AAMO,SAAS,QAAQ,SAAgB;AAExC;AAOO,SAAS,OAAO,SAAmC;AACxD,SAAO,YAAY;AACrB;AAQO,SAAS,UAAU,SAAsD;AAC9E,SAAO,OAAO,OAAO,KAAK,YAAY,OAAO,KAAK,OAAO,OAAO;AAClE;AAOO,SAAS,YACd,SAC2E;AACpE,SAAA,OAAO,OAAO,KAAK,EAAE,OAAO,YAAY,YAAY,OAAO,YAAY;AAChF;AAOO,SAAS,SAAS,SAAwC;AACxD,SAAA,OAAO,OAAO,MAAM;AAC7B;AAOO,SAAS,QAAQ,SAAuC;AACtD,SAAA,MAAM,QAAQ,OAAO;AAC9B;AAOO,SAAS,WAAW,SAA0C;AACnE,SAAO,OAAO,YAAY;AAC5B;AAcO,SAAS,gBAAgB,SAA+C;AAC7E,SAAO,WAAW,OAAO,KAAK,QAAQ,YAAY,SAAS;AAC7D;AAOO,SAAS,QAAQ,SAAoC;AAC1D,SAAO,mBAAmB;AAC5B;AAOO,SAAS,UAAa,SAAyC;AAC7D,SAAA,OAAO,OAAO,MAAM;AAC7B;AAOO,SAAS,OAAO,SAAmC;AACxD,SAAO,mBAAmB;AAC5B;;;;;;;;;;;;;;;;;;;;"}
|
|
@@ -1,158 +1,93 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
1
|
+
import { AnyArray, AnyAsyncFunction, AnyFunction, AnyObject } from './types';
|
|
3
2
|
/**
|
|
4
3
|
* 获取未知类型的类型名称
|
|
5
4
|
* @param unknown - 未知类型的值
|
|
6
5
|
* @returns 类型名称字符串
|
|
7
6
|
*/
|
|
8
|
-
export function typeIs(
|
|
9
|
-
unknown: unknown,
|
|
10
|
-
):
|
|
11
|
-
| 'string'
|
|
12
|
-
| 'number'
|
|
13
|
-
| 'boolean'
|
|
14
|
-
| 'object'
|
|
15
|
-
| 'array'
|
|
16
|
-
| 'function'
|
|
17
|
-
| 'null'
|
|
18
|
-
| 'undefined'
|
|
19
|
-
| 'symbol'
|
|
20
|
-
| 'bigint'
|
|
21
|
-
| 'error'
|
|
22
|
-
| 'promise'
|
|
23
|
-
| string {
|
|
24
|
-
return Object.prototype.toString.call(unknown).slice(8, -1).toLowerCase();
|
|
25
|
-
}
|
|
26
|
-
|
|
7
|
+
export declare function typeIs(unknown: unknown): 'string' | 'number' | 'boolean' | 'object' | 'array' | 'function' | 'null' | 'undefined' | 'symbol' | 'bigint' | 'error' | 'promise' | string;
|
|
27
8
|
/**
|
|
28
9
|
* 检查值是否为字符串
|
|
29
10
|
* @param unknown - 未知类型的值
|
|
30
11
|
* @returns 如果值为字符串则返回 true,否则返回 false
|
|
31
12
|
*/
|
|
32
|
-
export function isString(unknown: unknown): unknown is string
|
|
33
|
-
return typeof unknown === 'string';
|
|
34
|
-
}
|
|
35
|
-
|
|
13
|
+
export declare function isString(unknown: unknown): unknown is string;
|
|
36
14
|
/**
|
|
37
15
|
* 检查值是否为布尔值
|
|
38
16
|
* @param unknown - 未知类型的值
|
|
39
17
|
* @returns 如果值为布尔值则返回 true,否则返回 false
|
|
40
18
|
*/
|
|
41
|
-
export function isBoolean(unknown: unknown): unknown is boolean
|
|
42
|
-
return typeof unknown === 'boolean';
|
|
43
|
-
}
|
|
44
|
-
|
|
19
|
+
export declare function isBoolean(unknown: unknown): unknown is boolean;
|
|
45
20
|
/**
|
|
46
21
|
* 检查值是否为符号
|
|
47
22
|
* @param unknown - 未知类型的值
|
|
48
23
|
* @returns 如果值为符号则返回 true,否则返回 false
|
|
49
24
|
*/
|
|
50
|
-
export function isSymbol(unknown: unknown): unknown is symbol
|
|
51
|
-
return typeof unknown === 'symbol';
|
|
52
|
-
}
|
|
53
|
-
|
|
25
|
+
export declare function isSymbol(unknown: unknown): unknown is symbol;
|
|
54
26
|
/**
|
|
55
27
|
* 检查值是否为大整数
|
|
56
28
|
* @param unknown - 未知类型的值
|
|
57
29
|
* @returns 如果值为大整数则返回 true,否则返回 false
|
|
58
30
|
*/
|
|
59
|
-
export function isBigInt(unknown: unknown): unknown is bigint
|
|
60
|
-
return typeof unknown === 'bigint';
|
|
61
|
-
}
|
|
62
|
-
|
|
31
|
+
export declare function isBigInt(unknown: unknown): unknown is bigint;
|
|
63
32
|
/**
|
|
64
33
|
* 检查值是否为数字
|
|
65
34
|
* @param unknown - 未知类型的值
|
|
66
35
|
* @returns 如果值为数字且不是 NaN 则返回 true,否则返回 false
|
|
67
36
|
*/
|
|
68
|
-
export function isNumber(unknown: unknown): unknown is number
|
|
69
|
-
return typeof unknown === 'number' && !Number.isNaN(unknown);
|
|
70
|
-
}
|
|
71
|
-
|
|
37
|
+
export declare function isNumber(unknown: unknown): unknown is number;
|
|
72
38
|
/**
|
|
73
39
|
* 检查值是否为 undefined
|
|
74
40
|
* @param unknown - 未知类型的值
|
|
75
41
|
* @returns 如果值为 undefined 则返回 true,否则返回 false
|
|
76
42
|
*/
|
|
77
|
-
export function isUndefined(unknown: unknown): unknown is undefined
|
|
78
|
-
return typeof unknown === 'undefined';
|
|
79
|
-
}
|
|
80
|
-
|
|
43
|
+
export declare function isUndefined(unknown: unknown): unknown is undefined;
|
|
81
44
|
/**
|
|
82
45
|
* 检查值是否为 void
|
|
83
46
|
* @param unknown - 未知类型的值
|
|
84
47
|
* @returns 如果值为 undefined 则返回 true,否则返回 false
|
|
85
48
|
*/
|
|
86
|
-
|
|
87
|
-
export function isVoid(unknown: unknown): unknown is void {
|
|
88
|
-
return isUndefined(unknown);
|
|
89
|
-
}
|
|
90
|
-
|
|
49
|
+
export declare function isVoid(unknown: unknown): unknown is void;
|
|
91
50
|
/**
|
|
92
51
|
* 永不执行,用于 switch-case/if-else 类型断言
|
|
93
52
|
* @param unknown - 永远不会执行的值
|
|
94
53
|
*/
|
|
95
|
-
export function isNever(unknown: never)
|
|
96
|
-
//
|
|
97
|
-
}
|
|
98
|
-
|
|
54
|
+
export declare function isNever(unknown: never): void;
|
|
99
55
|
/**
|
|
100
56
|
* 检查值是否为 null
|
|
101
57
|
* @param unknown - 未知类型的值
|
|
102
58
|
* @returns 如果值为 null 则返回 true,否则返回 false
|
|
103
59
|
*/
|
|
104
|
-
export function isNull(unknown: unknown): unknown is null
|
|
105
|
-
return unknown === null;
|
|
106
|
-
}
|
|
107
|
-
|
|
60
|
+
export declare function isNull(unknown: unknown): unknown is null;
|
|
108
61
|
/**
|
|
109
62
|
* 检查值是否为 nullish(null 或 undefined 或 void)
|
|
110
63
|
* @param unknown - 未知类型的值
|
|
111
64
|
* @returns 如果值为 null 或 undefined 或 void 则返回 true,否则返回 false
|
|
112
65
|
*/
|
|
113
|
-
|
|
114
|
-
export function isNullish(unknown: unknown): unknown is null | undefined | void {
|
|
115
|
-
return isNull(unknown) || isUndefined(unknown) || isVoid(unknown);
|
|
116
|
-
}
|
|
117
|
-
|
|
66
|
+
export declare function isNullish(unknown: unknown): unknown is null | undefined | void;
|
|
118
67
|
/**
|
|
119
68
|
* 检查值是否为原始类型(null 或 非对象)
|
|
120
69
|
* @param unknown - 未知类型的值
|
|
121
70
|
* @returns 如果值为原始类型则返回 true,否则返回 false
|
|
122
71
|
*/
|
|
123
|
-
export function isPrimitive(
|
|
124
|
-
unknown: unknown,
|
|
125
|
-
): unknown is string | number | boolean | symbol | bigint | null | undefined {
|
|
126
|
-
return isNull(unknown) || !(typeof unknown === 'object' || typeof unknown === 'function');
|
|
127
|
-
}
|
|
128
|
-
|
|
72
|
+
export declare function isPrimitive(unknown: unknown): unknown is string | number | boolean | symbol | bigint | null | undefined;
|
|
129
73
|
/**
|
|
130
74
|
* 检查值是否为对象,但要注意,此时的对象类型是包含了数组和函数
|
|
131
75
|
* @param unknown - 未知类型的值
|
|
132
76
|
* @returns 如果值为对象则返回 true,否则返回 false
|
|
133
77
|
*/
|
|
134
|
-
export function isObject(unknown: unknown): unknown is AnyObject
|
|
135
|
-
return typeIs(unknown) === 'object';
|
|
136
|
-
}
|
|
137
|
-
|
|
78
|
+
export declare function isObject(unknown: unknown): unknown is AnyObject;
|
|
138
79
|
/**
|
|
139
80
|
* 检查值是否为数组
|
|
140
81
|
* @param unknown - 未知类型的值
|
|
141
82
|
* @returns 如果值为数组则返回 true,否则返回 false
|
|
142
83
|
*/
|
|
143
|
-
export function isArray(unknown: unknown): unknown is AnyArray
|
|
144
|
-
return Array.isArray(unknown);
|
|
145
|
-
}
|
|
146
|
-
|
|
84
|
+
export declare function isArray(unknown: unknown): unknown is AnyArray;
|
|
147
85
|
/**
|
|
148
86
|
* 检查值是否为函数
|
|
149
87
|
* @param unknown - 未知类型的值
|
|
150
88
|
* @returns 如果值为函数则返回 true,否则返回 false
|
|
151
89
|
*/
|
|
152
|
-
export function isFunction(unknown: unknown): unknown is AnyFunction
|
|
153
|
-
return typeof unknown === 'function';
|
|
154
|
-
}
|
|
155
|
-
|
|
90
|
+
export declare function isFunction(unknown: unknown): unknown is AnyFunction;
|
|
156
91
|
/**
|
|
157
92
|
* 检查值是否为异步函数
|
|
158
93
|
* @param unknown - 需要检查的值
|
|
@@ -165,33 +100,22 @@ export function isFunction(unknown: unknown): unknown is AnyFunction {
|
|
|
165
100
|
* isAsyncFunction(() => {}); // false
|
|
166
101
|
* ```
|
|
167
102
|
*/
|
|
168
|
-
export function isAsyncFunction(unknown: unknown): unknown is AnyAsyncFunction
|
|
169
|
-
return isFunction(unknown) && unknown.constructor.name === 'AsyncFunction';
|
|
170
|
-
}
|
|
171
|
-
|
|
103
|
+
export declare function isAsyncFunction(unknown: unknown): unknown is AnyAsyncFunction;
|
|
172
104
|
/**
|
|
173
105
|
* 检查值是否为 Error 类型
|
|
174
106
|
* @param unknown - 未知类型的值
|
|
175
107
|
* @returns 如果值为 Error 类型则返回 true,否则返回 false
|
|
176
108
|
*/
|
|
177
|
-
export function isError(unknown: unknown): unknown is Error
|
|
178
|
-
return unknown instanceof Error;
|
|
179
|
-
}
|
|
180
|
-
|
|
109
|
+
export declare function isError(unknown: unknown): unknown is Error;
|
|
181
110
|
/**
|
|
182
111
|
* 检查值是否为 Promise 类型
|
|
183
112
|
* @param unknown - 未知类型的值
|
|
184
113
|
* @returns 如果值为 Promise 类型则返回 true,否则返回 false
|
|
185
114
|
*/
|
|
186
|
-
export function isPromise<T>(unknown: unknown): unknown is Promise<T
|
|
187
|
-
return typeIs(unknown) === 'promise';
|
|
188
|
-
}
|
|
189
|
-
|
|
115
|
+
export declare function isPromise<T>(unknown: unknown): unknown is Promise<T>;
|
|
190
116
|
/**
|
|
191
117
|
* 检查值是否为 Date 类型
|
|
192
118
|
* @param unknown - 未知类型的值
|
|
193
119
|
* @returns 如果值为 Date 类型则返回 true,否则返回 false
|
|
194
120
|
*/
|
|
195
|
-
export function isDate(unknown: unknown): unknown is Date
|
|
196
|
-
return unknown instanceof Date;
|
|
197
|
-
}
|
|
121
|
+
export declare function isDate(unknown: unknown): unknown is Date;
|