@fast-china/utils 2.0.0 → 2.0.2

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.
Files changed (80) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/Fast.png +0 -0
  3. package/README.md +27 -29
  4. package/README.zh.md +27 -29
  5. package/dist/base64/index.mjs.map +1 -1
  6. package/dist/crypto/index.d.mts +265 -96
  7. package/dist/crypto/index.mjs +563 -261
  8. package/dist/crypto/index.mjs.map +1 -1
  9. package/dist/identity/index.d.mts +5 -5
  10. package/dist/identity/index.mjs +2 -2
  11. package/dist/identity/index.mjs.map +1 -1
  12. package/dist/index.d.mts +3 -3
  13. package/dist/index.global.min.js +3 -0
  14. package/dist/index.global.min.js.map +1 -0
  15. package/dist/index.mjs +2 -2
  16. package/dist/storage/index.d.mts +11 -8
  17. package/dist/storage/index.mjs +21 -18
  18. package/dist/storage/index.mjs.map +1 -1
  19. package/dist/vue/emits.mjs.map +1 -1
  20. package/dist/vue/index.d.mts +2 -2
  21. package/dist/vue/install.d.mts +11 -29
  22. package/dist/vue/install.mjs +25 -25
  23. package/dist/vue/install.mjs.map +1 -1
  24. package/dist/vue/props.mjs.map +1 -1
  25. package/dist/vue/render.d.mts +2 -3
  26. package/dist/vue/render.mjs +3 -9
  27. package/dist/vue/render.mjs.map +1 -1
  28. package/docs/API.md +30 -14
  29. package/docs/API.zh-CN.md +30 -14
  30. package/docs/DEVELOPMENT_RELEASE.zh-CN.md +4 -4
  31. package/docs/RUNTIME_CONTRACT.md +10 -10
  32. package/package.json +9 -11
  33. package/dist/array/index.d.mts.map +0 -1
  34. package/dist/async/index.d.mts.map +0 -1
  35. package/dist/base64/index.d.mts.map +0 -1
  36. package/dist/color/index.d.mts.map +0 -1
  37. package/dist/crypto/index.d.mts.map +0 -1
  38. package/dist/date/index.d.mts.map +0 -1
  39. package/dist/dom/style.d.mts.map +0 -1
  40. package/dist/env/index.d.mts.map +0 -1
  41. package/dist/identity/index.d.mts.map +0 -1
  42. package/dist/logger/index.d.mts.map +0 -1
  43. package/dist/number/index.d.mts.map +0 -1
  44. package/dist/object/index.d.mts.map +0 -1
  45. package/dist/storage/index.d.mts.map +0 -1
  46. package/dist/string/index.d.mts.map +0 -1
  47. package/dist/vue/emits.d.mts.map +0 -1
  48. package/dist/vue/expose.d.mts.map +0 -1
  49. package/dist/vue/func.d.mts.map +0 -1
  50. package/dist/vue/install.d.mts.map +0 -1
  51. package/dist/vue/props.d.mts.map +0 -1
  52. package/dist/vue/render.d.mts.map +0 -1
  53. package/dist/vue/slots.d.mts.map +0 -1
  54. package/dist/vue/with.d.mts.map +0 -1
  55. package/src/array/index.ts +0 -173
  56. package/src/async/index.ts +0 -475
  57. package/src/base64/index.ts +0 -374
  58. package/src/color/index.ts +0 -208
  59. package/src/crypto/index.ts +0 -670
  60. package/src/date/index.ts +0 -451
  61. package/src/dom/index.ts +0 -6
  62. package/src/dom/style.ts +0 -92
  63. package/src/env/index.ts +0 -169
  64. package/src/identity/index.ts +0 -144
  65. package/src/index.ts +0 -20
  66. package/src/internal/text.ts +0 -46
  67. package/src/logger/index.ts +0 -219
  68. package/src/number/index.ts +0 -235
  69. package/src/object/index.ts +0 -160
  70. package/src/storage/index.ts +0 -524
  71. package/src/string/index.ts +0 -328
  72. package/src/vue/emits.ts +0 -71
  73. package/src/vue/expose.ts +0 -11
  74. package/src/vue/func.ts +0 -17
  75. package/src/vue/index.ts +0 -13
  76. package/src/vue/install.ts +0 -185
  77. package/src/vue/props.ts +0 -39
  78. package/src/vue/render.ts +0 -41
  79. package/src/vue/slots.ts +0 -23
  80. package/src/vue/with.ts +0 -10
@@ -1,173 +0,0 @@
1
- /** 从数组项中提取可比较键的函数。 */
2
- export type KeySelector<Item, Key> = (item: Item, index: number) => Key;
3
-
4
- /**
5
- * 将只读数组按固定大小分组。
6
- *
7
- * @typeParam Item - 数组项类型。
8
- * @param items - 不会被修改的输入数组。
9
- * @param size - 每组最多包含的项目数,必须是正安全整数。
10
- * @returns 新建的二维数组;最后一组可能小于 `size`。
11
- * @throws `RangeError` 当 `size` 不是正安全整数。
12
- */
13
- export function chunk<Item>(items: readonly Item[], size: number): Item[][] {
14
- if (!Number.isSafeInteger(size) || size <= 0) {
15
- throw new RangeError("size must be a positive safe integer.");
16
- }
17
-
18
- const result: Item[][] = [];
19
- for (let index = 0; index < items.length; index += size) {
20
- result.push(items.slice(index, index + size));
21
- }
22
- return result;
23
- }
24
-
25
- /**
26
- * 删除数组中的 `null` 与 `undefined`,保留 `false`、`0` 和空字符串。
27
- *
28
- * @param items - 可包含空值的只读数组。
29
- * @returns 保持原顺序的新数组。
30
- */
31
- export function removeNullishValues<Item>(items: readonly (Item | null | undefined)[]): Item[] {
32
- return items.filter((item): item is Item => item !== null && item !== undefined);
33
- }
34
-
35
- /**
36
- * 使用 JavaScript `Set` 的 SameValueZero 语义去重。
37
- *
38
- * @param items - 不会被修改的输入数组。
39
- * @returns 保留每个值首次出现顺序的新数组;稀疏数组空位被忽略。
40
- */
41
- export function unique<Item>(items: readonly Item[]): Item[] {
42
- const result: Item[] = [];
43
- const seen = new Set<Item>();
44
- for (let index = 0; index < items.length; index += 1) {
45
- if (!(index in items)) continue;
46
- const item = items[index] as Item;
47
- if (seen.has(item)) continue;
48
- seen.add(item);
49
- result.push(item);
50
- }
51
- return result;
52
- }
53
-
54
- /**
55
- * 按选择器返回的键去重。
56
- *
57
- * @param items - 不会被修改的输入数组。
58
- * @param selectKey - 接收项目与索引并返回去重键的函数。
59
- * @returns 保留每个键首次出现项目的新数组;稀疏数组空位被忽略。
60
- */
61
- export function uniqueBy<Item, Key>(items: readonly Item[], selectKey: KeySelector<Item, Key>): Item[] {
62
- const seen = new Set<Key>();
63
- const result: Item[] = [];
64
- for (let index = 0; index < items.length; index += 1) {
65
- const item = items[index];
66
- if (item === undefined && !(index in items)) continue;
67
- const key = selectKey(item as Item, index);
68
- if (seen.has(key)) continue;
69
- seen.add(key);
70
- result.push(item as Item);
71
- }
72
- return result;
73
- }
74
-
75
- /**
76
- * 按选择器结果分组。
77
- *
78
- * @param items - 不会被修改的输入数组。
79
- * @param selectKey - 返回任意 `Map` 键的函数。
80
- * @returns 按键首次出现顺序排列的 `Map`;每个分组保持输入顺序,稀疏空位被忽略。
81
- */
82
- export function groupBy<Item, Key>(items: readonly Item[], selectKey: KeySelector<Item, Key>): Map<Key, Item[]> {
83
- const groups = new Map<Key, Item[]>();
84
- items.forEach((item, index) => {
85
- const key = selectKey(item, index);
86
- const group = groups.get(key);
87
- if (group === undefined) groups.set(key, [item]);
88
- else group.push(item);
89
- });
90
- return groups;
91
- }
92
-
93
- /**
94
- * 按谓词把数组拆分为匹配项和非匹配项。
95
- *
96
- * @param items - 不会被修改的输入数组。
97
- * @param predicate - 接收项目与索引的判断函数。
98
- * @returns 二元组:第一项匹配谓词,第二项不匹配;两组都保持原顺序并忽略稀疏空位。
99
- */
100
- export function partition<Item>(items: readonly Item[], predicate: (item: Item, index: number) => boolean): [matched: Item[], unmatched: Item[]] {
101
- const matched: Item[] = [];
102
- const unmatched: Item[] = [];
103
- items.forEach((item, index) => (predicate(item, index) ? matched : unmatched).push(item));
104
- return [matched, unmatched];
105
- }
106
-
107
- /**
108
- * 返回只出现在左侧数组中的不同值。
109
- *
110
- * @param left - 主输入数组。
111
- * @param right - 需要排除的值。
112
- * @returns 保留左侧首次出现顺序的去重结果;两侧稀疏空位都被忽略。
113
- */
114
- export function difference<Item>(left: readonly Item[], right: readonly Item[]): Item[] {
115
- const excluded = new Set(unique(right));
116
- return unique(left).filter((item) => !excluded.has(item));
117
- }
118
-
119
- /**
120
- * 返回两个数组共有的不同值。
121
- *
122
- * @param left - 决定结果顺序的数组。
123
- * @param right - 用于成员判断的数组。
124
- * @returns 保留左侧首次出现顺序的去重结果;两侧稀疏空位都被忽略。
125
- */
126
- export function intersection<Item>(left: readonly Item[], right: readonly Item[]): Item[] {
127
- const included = new Set(unique(right));
128
- return unique(left).filter((item) => included.has(item));
129
- }
130
-
131
- /**
132
- * 判断选择器产生的键是否重复。
133
- *
134
- * @param items - 不会被修改的输入数组。
135
- * @param selectKey - 返回比较键的函数;键使用 SameValueZero 语义比较。
136
- * @returns 存在至少一个重复键时返回 `true`。
137
- */
138
- export function hasDuplicatesBy<Item, Key>(items: readonly Item[], selectKey: KeySelector<Item, Key>): boolean {
139
- const seen = new Set<Key>();
140
- for (let index = 0; index < items.length; index += 1) {
141
- const item = items[index];
142
- if (item === undefined && !(index in items)) continue;
143
- const key = selectKey(item as Item, index);
144
- if (seen.has(key)) return true;
145
- seen.add(key);
146
- }
147
- return false;
148
- }
149
-
150
- /**
151
- * 判断所有项目是否具有相同的选择器结果。
152
- *
153
- * @remarks 空数组、只有稀疏空位的数组和单项数组按数学惯例返回 `true`;空位不会调用选择器。
154
- * @param items - 不会被修改的输入数组。
155
- * @param selectKey - 返回比较键的函数。
156
- * @returns 所有键都满足 SameValueZero 相等时返回 `true`。
157
- */
158
- export function allEqualBy<Item, Key>(items: readonly Item[], selectKey: KeySelector<Item, Key>): boolean {
159
- let first: Key | undefined;
160
- let hasFirst = false;
161
- for (let index = 0; index < items.length; index += 1) {
162
- const item = items[index];
163
- if (item === undefined && !(index in items)) continue;
164
- const current = selectKey(item as Item, index);
165
- if (!hasFirst) {
166
- first = current;
167
- hasFirst = true;
168
- continue;
169
- }
170
- if (!(first === current || (Number.isNaN(first) && Number.isNaN(current)))) return false;
171
- }
172
- return true;
173
- }
@@ -1,475 +0,0 @@
1
- /** 统一同步返回值与 PromiseLike 返回值的内部回调签名。 */
2
- type AsyncCallback<Arguments extends unknown[], Result> = (...arguments_: Arguments) => Result | PromiseLike<Result>;
3
-
4
- /** 记录同一防抖批次中每个调用方独立的 Promise 结算函数。 */
5
- interface PromiseWaiter<Result> {
6
- /**
7
- * 使用批次失败原因拒绝当前调用方。
8
- * @param reason - `cancel` 提供的原因或共享回调抛出的原始错误。
9
- */
10
- reject: (reason?: unknown) => void;
11
- /**
12
- * 使用共享回调结果完成当前调用方,并采用传入 PromiseLike 的最终状态。
13
- * @param value - 当前防抖批次唯一一次回调执行产生的共享结果。
14
- */
15
- resolve: (value: Result | PromiseLike<Result>) => void;
16
- }
17
-
18
- // 浏览器和 Node.js 的计时器普遍以有符号 32 位整数保存延迟;更大的值可能被
19
- // 静默截断为约 1 ms,因此公共 API 在进入平台计时器前统一拒绝它。
20
- const maximumTimerDelay = 2_147_483_647;
21
-
22
- /** 可接收取消信号的通用选项。 */
23
- export interface AbortOptions {
24
- /** 已取消时立即失败;运行期间取消时停止等待并拒绝 Promise。 */
25
- signal?: AbortSignal;
26
- }
27
-
28
- /** {@link withTimeout} 的行为选项。 */
29
- export interface TimeoutOptions extends AbortOptions {
30
- /** 超时时使用的开发者消息。 */
31
- message?: string;
32
- }
33
-
34
- /** 每次重试操作接收的上下文。 */
35
- export interface RetryContext {
36
- /** 从 1 开始的当前尝试次数。 */
37
- attempt: number;
38
- /** 调用方提供的取消信号。 */
39
- signal?: AbortSignal;
40
- }
41
-
42
- /** {@link retry} 的策略选项。 */
43
- export interface RetryOptions extends AbortOptions {
44
- /** 最大尝试次数,包含首次调用;默认 `3`。 */
45
- attempts?: number;
46
- /** 首次重试前的等待毫秒数,最大 2,147,483,647;默认 `200`。 */
47
- delayMs?: number;
48
- /** 每次失败后的退避倍数,必须不小于 1;默认 `2`。 */
49
- factor?: number;
50
- /** 单次等待上限,最大 2,147,483,647;默认 `30_000` 毫秒。 */
51
- maxDelayMs?: number;
52
- /**
53
- * 决定当前失败后是否继续下一次尝试;默认重试所有尚未到达上限的错误。
54
- * @param error - 当前操作抛出或拒绝的原始值。
55
- * @param context - 当前尝试次数和调用方取消信号。
56
- * @returns `false` 时立即原样抛出当前错误;支持同步值或 PromiseLike。
57
- */
58
- shouldRetry?: (error: unknown, context: RetryContext) => boolean | PromiseLike<boolean>;
59
- }
60
-
61
- /** {@link mapConcurrent} 的执行选项。 */
62
- export interface ConcurrentMapOptions {
63
- /** 已取消时停止调度新任务;已经开始的映射器需要自行响应同一信号。 */
64
- signal?: AbortSignal;
65
- }
66
-
67
- /** Promise 感知的防抖函数。 */
68
- export interface DebouncedFunction<Arguments extends unknown[], Result> {
69
- /**
70
- * 调度一次调用;同一等待窗口内的调用共享最后一组参数对应的结果。
71
- * @param arguments_ - 传给原始回调的参数;后续调用会覆盖尚未执行批次保存的参数。
72
- * @returns 当前批次的独立 Promise,最终与共享回调结果保持相同状态。
73
- */
74
- (...arguments_: Arguments): Promise<Result>;
75
- /**
76
- * 取消尚未执行的批次,并拒绝该批次的所有 Promise。
77
- * @param reason - 可选拒绝原因;省略时使用内部取消错误。
78
- */
79
- cancel: (reason?: unknown) => void;
80
- /**
81
- * 立即执行待处理批次,不创建第二次回调执行。
82
- * @returns 待处理批次的共享执行 Promise;没有批次时返回 `undefined`。
83
- */
84
- flush: () => Promise<Result> | undefined;
85
- /** @returns 当前存在尚未开始的批次时返回 `true`;正在执行但没有等待批次时返回 `false`。 */
86
- pending: () => boolean;
87
- }
88
-
89
- /** Promise 感知的前缘节流函数。 */
90
- export interface ThrottledFunction<Arguments extends unknown[], Result> {
91
- /**
92
- * 在空闲时立即调用原始回调;执行期和冷却期内的调用共享首次调用的 Promise。
93
- * @param arguments_ - 仅窗口内首次调用的参数会传给原始回调。
94
- * @returns 当前执行窗口共享的 Promise。
95
- */
96
- (...arguments_: Arguments): Promise<Result>;
97
- /** 提前结束冷却期;已经开始的操作不会被取消,结束前仍禁止并发重入。 */
98
- cancel: () => void;
99
- /** @returns 原始回调正在执行或计时器仍处于冷却期时返回 `true`。 */
100
- pending: () => boolean;
101
- }
102
-
103
- /**
104
- * 创建符合 Web Platform 约定的取消错误。
105
- *
106
- * @param signal - 已进入取消状态的信号;其 `reason` 会保存在错误的 `cause` 中。
107
- * @returns 名称为 `AbortError` 的新错误实例。
108
- */
109
- const createAbortError = (signal: AbortSignal): Error => {
110
- const error = new Error("The operation was aborted.", { cause: signal.reason });
111
- error.name = "AbortError";
112
- return error;
113
- };
114
-
115
- /**
116
- * 在启动异步工作前同步拒绝已经取消的信号。
117
- *
118
- * @param signal - 可选取消信号;省略或尚未取消时不执行操作。
119
- * @throws `Error` 当信号已经取消,错误名称为 `AbortError`。
120
- */
121
- const throwIfAborted = (signal: AbortSignal | undefined): void => {
122
- if (signal?.aborted) throw createAbortError(signal);
123
- };
124
-
125
- /**
126
- * 校验宿主计时器可以稳定表示的延迟。
127
- *
128
- * @param milliseconds - 待校验的毫秒数。
129
- * @param name - 用于错误消息的参数名称。
130
- * @returns 原始延迟值,便于调用方在校验后直接使用。
131
- * @throws `RangeError` 当值非有限、为负数或超过 32 位计时器上限。
132
- */
133
- const assertDelay = (milliseconds: number, name = "milliseconds"): number => {
134
- if (!Number.isFinite(milliseconds) || milliseconds < 0 || milliseconds > maximumTimerDelay) {
135
- throw new RangeError(`${name} must be a finite number from 0 through ${maximumTimerDelay}.`);
136
- }
137
- return milliseconds;
138
- };
139
-
140
- /**
141
- * 等待指定时间,并支持 `AbortSignal`。
142
- *
143
- * @param milliseconds - 0 至 2,147,483,647 的有限毫秒数。
144
- * @param options - 可选取消信号。
145
- * @returns 到期后完成的 Promise。
146
- * @throws 取消时抛出名称为 `AbortError` 的 `Error`;参数非法时抛出 `RangeError`。
147
- */
148
- export function sleep(milliseconds: number, options: AbortOptions = {}): Promise<void> {
149
- const delay = assertDelay(milliseconds);
150
- const signal = options.signal;
151
- throwIfAborted(signal);
152
-
153
- return new Promise<void>((resolve, reject) => {
154
- /** 取消计时器并使用标准取消错误拒绝等待。 */
155
- const onAbort = (): void => {
156
- if (signal === undefined) return;
157
- clearTimeout(timer);
158
- reject(createAbortError(signal));
159
- };
160
- const timer = setTimeout(() => {
161
- signal?.removeEventListener("abort", onAbort);
162
- resolve();
163
- }, delay);
164
- signal?.addEventListener("abort", onAbort, { once: true });
165
- });
166
- }
167
-
168
- /**
169
- * 为 Promise 增加等待上限。
170
- *
171
- * @remarks 超时或取消只停止等待,不能自动取消底层操作;需要真正取消时应同时把
172
- * 同一个 `AbortSignal` 传给底层 API。
173
- * @param promise - 需要等待的 Promise 或 PromiseLike。
174
- * @param timeoutMs - 0 至 2,147,483,647 的有限等待时间。
175
- * @param options - 取消信号与自定义消息。
176
- * @returns 底层 Promise 的结果。
177
- * @throws 超时抛出 `Error`,取消时抛出名称为 `AbortError` 的 `Error`;等待时间非法时抛出 `RangeError`。
178
- */
179
- export function withTimeout<Result>(promise: PromiseLike<Result>, timeoutMs: number, options: TimeoutOptions = {}): Promise<Result> {
180
- const delay = assertDelay(timeoutMs, "timeoutMs");
181
- const signal = options.signal;
182
- throwIfAborted(signal);
183
-
184
- return new Promise<Result>((resolve, reject) => {
185
- let settled = false;
186
- /** 清理竞争结束后不再需要的计时器和监听器。 */
187
- const cleanup = (): void => {
188
- clearTimeout(timer);
189
- signal?.removeEventListener("abort", onAbort);
190
- };
191
- /**
192
- * 只允许 Promise、超时和取消三个竞争来源中的首个结果生效。
193
- *
194
- * @param action - 首个完成来源的结算动作。
195
- */
196
- const settle = (action: () => void): void => {
197
- if (settled) return;
198
- settled = true;
199
- cleanup();
200
- action();
201
- };
202
- /** 使用调用方取消原因结束当前等待。 */
203
- const onAbort = (): void => {
204
- if (signal === undefined) return;
205
- settle(() => {
206
- reject(createAbortError(signal));
207
- });
208
- };
209
- const timer = setTimeout(() => {
210
- settle(() => {
211
- reject(new Error(options.message ?? `The operation exceeded ${delay} ms.`));
212
- });
213
- }, delay);
214
-
215
- signal?.addEventListener("abort", onAbort, { once: true });
216
- Promise.resolve(promise).then(
217
- (value) => {
218
- settle(() => {
219
- resolve(value);
220
- });
221
- },
222
- (error: unknown) => {
223
- settle(() => {
224
- reject(error);
225
- });
226
- }
227
- );
228
- });
229
- }
230
-
231
- /**
232
- * 使用有上限的指数退避重试操作。
233
- *
234
- * @typeParam Result - 操作结果类型。
235
- * @param operation - 每次尝试都会调用的函数;`attempt` 从 1 开始。
236
- * @param options - 尝试次数、退避和取消策略。
237
- * @returns 首次成功结果。
238
- * @throws 最后一次操作错误、`shouldRetry` 错误或名称为 `AbortError` 的取消错误;策略参数非法时抛出 `RangeError`。
239
- */
240
- export async function retry<Result>(
241
- operation: (context: RetryContext) => Result | PromiseLike<Result>,
242
- options: RetryOptions = {}
243
- ): Promise<Awaited<Result>> {
244
- const attempts = options.attempts ?? 3;
245
- const initialDelay = assertDelay(options.delayMs ?? 200, "delayMs");
246
- const maximumDelay = assertDelay(options.maxDelayMs ?? 30_000, "maxDelayMs");
247
- const factor = options.factor ?? 2;
248
- if (!Number.isSafeInteger(attempts) || attempts <= 0) throw new RangeError("attempts must be a positive safe integer.");
249
- if (!Number.isFinite(factor) || factor < 1) throw new RangeError("factor must be a finite number greater than or equal to 1.");
250
-
251
- for (let attempt = 1; attempt <= attempts; attempt += 1) {
252
- throwIfAborted(options.signal);
253
- const context: RetryContext = options.signal === undefined ? { attempt } : { attempt, signal: options.signal };
254
- try {
255
- return await operation(context);
256
- } catch (error) {
257
- if (attempt === attempts || (options.shouldRetry !== undefined && !(await options.shouldRetry(error, context)))) throw error;
258
- // `0 * Infinity` is `NaN`; a zero initial delay must remain zero even when
259
- // a very large factor overflows during a later attempt.
260
- const delay = initialDelay === 0 ? 0 : Math.min(initialDelay * factor ** (attempt - 1), maximumDelay);
261
- await sleep(delay, options.signal === undefined ? {} : { signal: options.signal });
262
- }
263
- }
264
-
265
- throw new Error("Retry finished without a result.");
266
- }
267
-
268
- /**
269
- * 以固定并发度映射数组,并保持结果顺序。
270
- *
271
- * @remarks 任一映射失败后不会再调度新项目,但已经开始的映射无法自动取消;映射器
272
- * 应使用传入的 `signal` 取消底层工作。
273
- * @param items - 不会被修改的输入数组。
274
- * @param concurrency - 同时运行的最大任务数,必须为正安全整数。
275
- * @param mapper - 接收项目、索引和取消信号的映射函数。
276
- * @param options - 可选取消信号。
277
- * @returns 与输入长度和顺序一致的结果数组;稀疏空位保持为空位且不会调用映射器。
278
- * @throws `RangeError` 当 `concurrency` 不是正安全整数;取消时抛出名称为 `AbortError` 的 `Error`。
279
- */
280
- export async function mapConcurrent<Item, Result>(
281
- items: readonly Item[],
282
- concurrency: number,
283
- mapper: (item: Item, index: number, signal: AbortSignal | undefined) => Result | PromiseLike<Result>,
284
- options: ConcurrentMapOptions = {}
285
- ): Promise<Awaited<Result>[]> {
286
- if (!Number.isSafeInteger(concurrency) || concurrency <= 0) {
287
- throw new RangeError("concurrency must be a positive safe integer.");
288
- }
289
- throwIfAborted(options.signal);
290
-
291
- const results = new Array<Awaited<Result>>(items.length);
292
- let nextIndex = 0;
293
- let failed = false;
294
- /**
295
- * 从共享游标持续领取映射任务。
296
- *
297
- * @remarks JavaScript 单线程执行保证“读取索引并递增”不会被另一个 Worker 插入,因此每个索引只会领取一次。
298
- * @returns 当前 Worker 没有剩余任务时完成。
299
- * @throws 原样传播取消错误或 Mapper 错误,并阻止其他 Worker 领取新任务。
300
- */
301
- const worker = async (): Promise<void> => {
302
- while (!failed) {
303
- throwIfAborted(options.signal);
304
- const index = nextIndex;
305
- if (index >= items.length) return;
306
- nextIndex += 1;
307
- if (!(index in items)) continue;
308
- try {
309
- results[index] = await mapper(items[index] as Item, index, options.signal);
310
- } catch (error) {
311
- failed = true;
312
- throw error;
313
- }
314
- }
315
- };
316
-
317
- const workerCount = Math.min(concurrency, items.length);
318
- await Promise.all(Array.from({ length: workerCount }, () => worker()));
319
- return results;
320
- }
321
-
322
- /**
323
- * 创建 Promise 感知的防抖函数。
324
- *
325
- * @remarks 同一窗口内的所有调用都会等待最后一组参数对应的执行结果;回调错误会原样
326
- * 拒绝该批次的全部调用,不会留下永久 pending 的 Promise。
327
- * @param callback - 同步或异步回调。
328
- * @param delayMs - 0 至 2,147,483,647 的有限等待时间,默认 300 毫秒。
329
- * @returns 具有取消、立即执行和状态方法的防抖函数。
330
- * @throws `RangeError` 当延迟不在平台计时器支持范围内。
331
- */
332
- export function debounce<Arguments extends unknown[], Result>(
333
- callback: AsyncCallback<Arguments, Result>,
334
- delayMs = 300
335
- ): DebouncedFunction<Arguments, Awaited<Result>> {
336
- const delay = assertDelay(delayMs, "delayMs");
337
- let timer: ReturnType<typeof setTimeout> | undefined;
338
- let latestArguments: Arguments | undefined;
339
- let waiters: PromiseWaiter<Awaited<Result>>[] = [];
340
-
341
- /**
342
- * 执行并结算当前防抖批次。
343
- *
344
- * @returns 最后一组参数对应的回调结果。
345
- * @throws 没有待处理批次时抛出 `Error`;回调错误会原样传播给批次中的全部调用方。
346
- */
347
- const execute = async (): Promise<Awaited<Result>> => {
348
- const arguments_ = latestArguments;
349
- if (arguments_ === undefined) {
350
- throw new Error("No debounced invocation is pending.");
351
- }
352
- latestArguments = undefined;
353
- timer = undefined;
354
- const currentWaiters = waiters;
355
- waiters = [];
356
- try {
357
- const result = await callback(...arguments_);
358
- currentWaiters.forEach((waiter) => {
359
- waiter.resolve(result);
360
- });
361
- return result;
362
- } catch (error) {
363
- currentWaiters.forEach((waiter) => {
364
- waiter.reject(error);
365
- });
366
- throw error;
367
- }
368
- };
369
-
370
- /**
371
- * 更新批次参数并返回当前调用方专属的等待 Promise。
372
- *
373
- * @param arguments_ - 本次调用参数;同批次中只有最后一组参数会执行。
374
- * @returns 与当前批次共享结果、但可独立结算的 Promise。
375
- */
376
- const debounced = (...arguments_: Arguments): Promise<Awaited<Result>> => {
377
- latestArguments = arguments_;
378
- if (timer !== undefined) clearTimeout(timer);
379
- timer = setTimeout(() => {
380
- void execute().catch(() => undefined);
381
- }, delay);
382
- return new Promise<Awaited<Result>>((resolve, reject) => waiters.push({ reject, resolve }));
383
- };
384
-
385
- debounced.cancel = (reason?: unknown): void => {
386
- if (timer !== undefined) clearTimeout(timer);
387
- timer = undefined;
388
- latestArguments = undefined;
389
- const error = reason ?? new Error("The debounced invocation was cancelled.");
390
- waiters.forEach((waiter) => {
391
- waiter.reject(error);
392
- });
393
- waiters = [];
394
- };
395
- debounced.flush = (): Promise<Awaited<Result>> | undefined => {
396
- if (timer === undefined) return undefined;
397
- clearTimeout(timer);
398
- return execute();
399
- };
400
- debounced.pending = (): boolean => timer !== undefined;
401
- return debounced;
402
- }
403
-
404
- /**
405
- * 创建 Promise 感知的前缘节流函数。
406
- *
407
- * @remarks 窗口内的调用共享首次调用结果。若回调执行时间超过窗口,后续调用仍会等待
408
- * 当前回调,避免异步操作重入;该函数不安排尾缘调用。
409
- * @param callback - 同步或异步回调。
410
- * @param delayMs - 0 至 2,147,483,647 的有限冷却时间,默认 300 毫秒。
411
- * @returns 具有取消和状态方法的前缘节流函数。
412
- * @throws `RangeError` 当延迟不在平台计时器支持范围内。
413
- */
414
- export function throttle<Arguments extends unknown[], Result>(
415
- callback: AsyncCallback<Arguments, Result>,
416
- delayMs = 300
417
- ): ThrottledFunction<Arguments, Awaited<Result>> {
418
- const delay = assertDelay(delayMs, "delayMs");
419
- let timer: ReturnType<typeof setTimeout> | undefined;
420
- let current: Promise<Awaited<Result>> | undefined;
421
- let cooling = false;
422
- let settled = false;
423
-
424
- /**
425
- * 尝试释放当前节流窗口。
426
- *
427
- * @remarks 只有回调和冷却计时器都结束后才清空共享 Promise,避免长回调发生重入。
428
- */
429
- const release = (): void => {
430
- if (!cooling && settled) current = undefined;
431
- };
432
- /**
433
- * 执行前缘调用或复用当前窗口的共享 Promise。
434
- *
435
- * @param arguments_ - 仅新窗口首个调用会使用的参数。
436
- * @returns 当前窗口首次调用的 Promise。
437
- */
438
- const throttled = (...arguments_: Arguments): Promise<Awaited<Result>> => {
439
- if (current !== undefined) return current;
440
- cooling = true;
441
- settled = false;
442
- let invocation: Promise<Awaited<Result>>;
443
- try {
444
- invocation = Promise.resolve(callback(...arguments_));
445
- } catch (error) {
446
- invocation = Promise.reject(error);
447
- }
448
- current = invocation;
449
- invocation.then(
450
- () => {
451
- settled = true;
452
- release();
453
- },
454
- () => {
455
- settled = true;
456
- release();
457
- }
458
- );
459
- timer = setTimeout(() => {
460
- timer = undefined;
461
- cooling = false;
462
- release();
463
- }, delay);
464
- return invocation;
465
- };
466
-
467
- throttled.cancel = (): void => {
468
- if (timer !== undefined) clearTimeout(timer);
469
- timer = undefined;
470
- cooling = false;
471
- release();
472
- };
473
- throttled.pending = (): boolean => current !== undefined;
474
- return throttled;
475
- }