@isdk/util 0.3.9 → 0.3.10

package/docs/classes/SignalGate.md

@@ -6,7 +6,7 @@
 
 # Class: SignalGate\<T\>
 
-Defined in: [src/async-signal-gate.ts:20](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L20)
+Defined in: [src/async-signal-gate.ts:20](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L20)
 
 An asynchronous signal gate that blocks operations until a signal is emitted.
 This class allows multiple awaiters to wait for a signal and resolves all pending promises with the emitted value.
@@ -46,7 +46,7 @@ valueGate.signal(42); // Must provide a number value
 
 > `protected` **\_isSignaled**: `boolean` = `false`
 
-Defined in: [src/async-signal-gate.ts:21](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L21)
+Defined in: [src/async-signal-gate.ts:21](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L21)
 
 ***
 
@@ -54,7 +54,7 @@ Defined in: [src/async-signal-gate.ts:21](https://github.com/isdk/util.js/blob/3
 
 > `protected` **\_signalValue**: `T` \| `undefined`
 
-Defined in: [src/async-signal-gate.ts:22](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L22)
+Defined in: [src/async-signal-gate.ts:22](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L22)
 
 ***
 
@@ -62,9 +62,9 @@ Defined in: [src/async-signal-gate.ts:22](https://github.com/isdk/util.js/blob/3
 
 > `protected` **waitQueue**: `object`[] = `[]`
 
-Defined in: [src/async-signal-gate.ts:23](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L23)
+Defined in: [src/async-signal-gate.ts:23](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L23)
 
-#### reject()
+#### reject
 
 > **reject**: (`error`) => `void`
 
@@ -78,7 +78,7 @@ Defined in: [src/async-signal-gate.ts:23](https://github.com/isdk/util.js/blob/3
 
 `void`
 
-#### resolve()
+#### resolve
 
 > **resolve**: (`value`) => `void`
 
@@ -100,7 +100,7 @@ Defined in: [src/async-signal-gate.ts:23](https://github.com/isdk/util.js/blob/3
 
 > **get** **signaled**(): `boolean`
 
-Defined in: [src/async-signal-gate.ts:28](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L28)
+Defined in: [src/async-signal-gate.ts:28](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L28)
 
 ##### Returns
 
@@ -112,7 +112,7 @@ Defined in: [src/async-signal-gate.ts:28](https://github.com/isdk/util.js/blob/3
 
 > **abort**(`reason?`): `void`
 
-Defined in: [src/async-signal-gate.ts:65](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L65)
+Defined in: [src/async-signal-gate.ts:65](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L65)
 
 Aborts all pending waits, rejecting their promises with an error.
 This does **not** reset the signal state (the gate remains signaled or unsignaled).
@@ -135,7 +135,7 @@ The reason for aborting the waits.
 
 > **reset**(): `void`
 
-Defined in: [src/async-signal-gate.ts:53](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L53)
+Defined in: [src/async-signal-gate.ts:53](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L53)
 
 Resets the gate to its initial state, allowing a new signal to be emitted.
 
@@ -149,7 +149,7 @@ Resets the gate to its initial state, allowing a new signal to be emitted.
 
 > **signal**(`value?`): `void`
 
-Defined in: [src/async-signal-gate.ts:38](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L38)
+Defined in: [src/async-signal-gate.ts:38](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L38)
 
 Emits the signal with an optional value, resolving all pending [wait](#wait) promises.
 Subsequent calls have no effect until [reset](#reset) is called.
@@ -172,7 +172,7 @@ The value to emit with the signal (only required if T is not void).
 
 > **wait**(): `Promise`\<`T`\>
 
-Defined in: [src/async-signal-gate.ts:83](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-signal-gate.ts#L83)
+Defined in: [src/async-signal-gate.ts:83](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-signal-gate.ts#L83)
 
 Returns a promise that resolves with the emitted signal value.
 If called after the signal has been emitted, resolves immediately with the stored value.

package/docs/functions/RateLimit.md

@@ -6,11 +6,13 @@
 
 # Function: RateLimit()
 
-> **RateLimit**(`rps`, `__namedParameters?`): () => `Promise`\<`void`\>
+> **RateLimit**(`rps`, `options?`): () => `Promise`\<`void`\>
 
-Defined in: [src/async-semaphore.ts:488](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L488)
+Defined in: [src/async-semaphore.ts:598](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-semaphore.ts#L598)
 
-Creates a rate limiter function that blocks with a promise whenever the rate limit is hit and resolves the promise once the call rate is within the limit set by rps. The second argument is optional.
+创建一个速率限制器函数（Rate Limiter）。
+当调用频率超过设定的 `rps`（每秒请求数）时，该函数会通过 Promise 阻塞调用方，
+并在调用率回到限制范围内时解析。
 
 ## Parameters
 
@@ -18,20 +20,41 @@ Creates a rate limiter function that blocks with a promise whenever the rate lim
 
 `number`
 
-### \_\_namedParameters?
+限制的速率。默认单位时间内允许的请求数。
+
+### options?
+
+配置项。
 
 #### timeUnit?
 
 `number` = `1000`
 
+时间窗口大小（毫秒）。默认为 1000ms。
+
 #### uniformDistribution?
 
 `boolean` = `false`
 
+是否强制离散均匀分布。
+   - 若为 `false`（默认）：允许在时间窗口开始时立即耗尽所有配额，然后暂停直到窗口结束。
+   - 若为 `true`：将配额均匀分配到时间窗口内（例如 5 rps 会每 200ms 允许一次请求）。
+     在流量持续且快速的场景下（如读取文件）建议开启，以避免瞬时突发流量。
+
 ## Returns
 
-> (): `Promise`\<`void`\>
+返回一个异步限流函数，调用该函数即可实现限流。
+
+示例：
+```ts
+const lim = RateLimit(5); // 限制为 5 次/秒
 
-### Returns
+async function processItems(items) {
+  for (const item of items) {
+    await lim(); // 可能会在这里阻塞
+    await handle(item);
+  }
+}
+```
 
-`Promise`\<`void`\>
+() => `Promise`\<`void`\>

package/docs/functions/arrayHasAll.md

@@ -8,7 +8,7 @@
 
 > **arrayHasAll**\<`T`\>(`array`, `elements`): `boolean`
 
-Defined in: [src/array-has-all.ts:15](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/array-has-all.ts#L15)
+Defined in: [src/array-has-all.ts:15](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/array-has-all.ts#L15)
 
 Checks whether the provided array contains all of the specified elements.
 

package/docs/functions/extNameLevel.md

@@ -8,7 +8,7 @@
 
 > **extNameLevel**(`extName`): `number`
 
-Defined in: [src/filename.ts:226](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L226)
+Defined in: [src/filename.ts:226](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/filename.ts#L226)
 
 Calculates the level of an extension name.
 

package/docs/functions/extractCodeBlock.md

@@ -8,7 +8,7 @@
 
 > **extractCodeBlock**(`text`, `langOrOptions?`): `string` \| [`CodeString`](../interfaces/CodeString.md) \| (`string` \| [`CodeString`](../interfaces/CodeString.md))[]
 
-Defined in: [src/extract-code-block.ts:198](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/extract-code-block.ts#L198)
+Defined in: [src/extract-code-block.ts:199](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/extract-code-block.ts#L199)
 
 Extracts fenced code block(s) from the input `text`, with support for nested path selectors.
 
@@ -26,9 +26,9 @@ The input string containing Markdown.
 
 ### langOrOptions?
 
-Either a language/selector string or a full [ExtractCodeBlockOptions](../interfaces/ExtractCodeBlockOptions.md) object.
+`string` \| `string`[] \| [`ExtractCodeBlockOptions`](../interfaces/ExtractCodeBlockOptions.md)
 
-`string` | [`ExtractCodeBlockOptions`](../interfaces/ExtractCodeBlockOptions.md)
+Either a language/selector string or a full [ExtractCodeBlockOptions](../interfaces/ExtractCodeBlockOptions.md) object.
 
 ## Returns
 

package/docs/functions/extractTopLevelCodeBlocks.md

@@ -8,7 +8,7 @@
 
 > **extractTopLevelCodeBlocks**(`text`, `options?`): [`CodeString`](../interfaces/CodeString.md)[]
 
-Defined in: [src/extract-code-block.ts:115](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/extract-code-block.ts#L115)
+Defined in: [src/extract-code-block.ts:115](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/extract-code-block.ts#L115)
 
 Extracts top-level fenced code blocks from the input `text`.
 

package/docs/functions/filenameReservedRegex.md

@@ -8,7 +8,7 @@
 
 > **filenameReservedRegex**(): `RegExp`
 
-Defined in: [src/filename.ts:44](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L44)
+Defined in: [src/filename.ts:44](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/filename.ts#L44)
 
 Returns a new regular expression instance for reserved filename characters with the 'g' flag.
 use this to reset the with global option

package/docs/functions/findPort.md

@@ -8,7 +8,7 @@
 
 > **findPort**(`port`, `options?`): `Promise`\<`number`\>
 
-Defined in: [src/find-port.ts:17](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/find-port.ts#L17)
+Defined in: [src/find-port.ts:17](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/find-port.ts#L17)
 
 Finds an available port.
 
@@ -16,15 +16,15 @@ Finds an available port.
 
 ### port
 
-The starting port number or a string representation of it. Defaults to 0 (random port).
+`string` \| `number` \| `undefined`
 
-`string` | `number` | `undefined`
+The starting port number or a string representation of it. Defaults to 0 (random port).
 
 ### options?
 
-Either the retry count (number) or an options object.
+`number` \| [`FindPortOptions`](../interfaces/FindPortOptions.md)
 
-`number` | [`FindPortOptions`](../interfaces/FindPortOptions.md)
+Either the retry count (number) or an options object.
 
 ## Returns
 

package/docs/functions/getMultiLevelExtname.md

@@ -8,7 +8,7 @@
 
 > **getMultiLevelExtname**(`filename`, `level?`): `string`
 
-Defined in: [src/get-multi-level-extname.ts:9](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/get-multi-level-extname.ts#L9)
+Defined in: [src/get-multi-level-extname.ts:9](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/get-multi-level-extname.ts#L9)
 
 Retrieves multi-level file extension
 

package/docs/functions/glob.md

@@ -8,7 +8,7 @@
 
 > **glob**(`filepath`, `pattern`, `rootDir?`): `boolean` \| `undefined`
 
-Defined in: [src/glob.ts:29](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/glob.ts#L29)
+Defined in: [src/glob.ts:29](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/glob.ts#L29)
 
 Matches a file path against a list of glob patterns.
 

package/docs/functions/isStringIn.md

@@ -8,7 +8,7 @@
 
 > **isStringIn**(`str`, `arr`): `boolean`
 
-Defined in: [src/is-string-in.ts:17](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/is-string-in.ts#L17)
+Defined in: [src/is-string-in.ts:17](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/is-string-in.ts#L17)
 
 Checks if a given string exists within an array of strings or a single string.
 
@@ -22,9 +22,9 @@ The string to search for.
 
 ### arr
 
-An array of strings or a single string to search within.
+`string` \| `string`[]
 
-`string` | `string`[]
+An array of strings or a single string to search within.
 
 ## Returns
 

package/docs/functions/isValidFilename.md

@@ -8,7 +8,7 @@
 
 > **isValidFilename**(`filename`): `boolean` \| `""`
 
-Defined in: [src/filename.ts:65](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L65)
+Defined in: [src/filename.ts:65](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/filename.ts#L65)
 
 Validates if a given string is a valid filename.
 

package/docs/functions/isValidFilepath.md

@@ -8,7 +8,7 @@
 
 > **isValidFilepath**(`filepath`): `boolean`
 
-Defined in: [src/filename.ts:82](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L82)
+Defined in: [src/filename.ts:82](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/filename.ts#L82)
 
 Validates whether the given filepath is valid.
 

package/docs/functions/normalizeIncludeFiles.md

@@ -8,7 +8,7 @@
 
 > **normalizeIncludeFiles**(`files?`, `defaultFiles?`): `string`[]
 
-Defined in: [src/include-files.ts:34](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/include-files.ts#L34)
+Defined in: [src/include-files.ts:34](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/include-files.ts#L34)
 
 Normalizes a list of file patterns for glob matching.
 
@@ -20,9 +20,9 @@ all text-based files as defined in `DefaultAllTextFiles`.
 
 ### files?
 
-Either an array of file patterns or an object with `include` and `exclude` properties.
+`string`[] \| [`IncludeFiles`](../interfaces/IncludeFiles.md)
 
-`string`[] | [`IncludeFiles`](../interfaces/IncludeFiles.md)
+Either an array of file patterns or an object with `include` and `exclude` properties.
 
 ### defaultFiles?
 

package/docs/functions/omitDeepBy.md

@@ -8,7 +8,7 @@
 
 > **omitDeepBy**\<`T`\>(`value`, `predicate`, `cache?`): `any`
 
-Defined in: [src/omit-deep-by.ts:92](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/omit-deep-by.ts#L92)
+Defined in: [src/omit-deep-by.ts:92](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/omit-deep-by.ts#L92)
 
 Recursively removes properties from an object or array that satisfy the given predicate condition.
 

package/docs/functions/omitEmptyDeep.md

@@ -8,7 +8,7 @@
 
 > **omitEmptyDeep**\<`T`\>(`value`, `omitFunc?`): `any`
 
-Defined in: [src/omit-empty-deep.ts:33](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/omit-empty-deep.ts#L33)
+Defined in: [src/omit-empty-deep.ts:33](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/omit-empty-deep.ts#L33)
 
 Deeply removes empty values from objects or arrays, supporting both string and Symbol keys.
 

package/docs/functions/parseCodeBlockSelector.md

@@ -8,7 +8,7 @@
 
 > **parseCodeBlockSelector**(`lang?`): [`CodeBlockSelectorPart`](../interfaces/CodeBlockSelectorPart.md)[]
 
-Defined in: [src/extract-code-block.ts:160](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/extract-code-block.ts#L160)
+Defined in: [src/extract-code-block.ts:160](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/extract-code-block.ts#L160)
 
 Parses a selector string into an array of structured [CodeBlockSelectorPart](../interfaces/CodeBlockSelectorPart.md) objects.
 
@@ -16,7 +16,7 @@ Parses a selector string into an array of structured [CodeBlockSelectorPart](../
 
 ### lang?
 
-`string`
+`string` \| `string`[]
 
 The selector string.
 

package/docs/functions/parseFrontMatter.md

@@ -8,7 +8,7 @@
 
 > **parseFrontMatter**(`value`, `delimiter?`): `object`
 
-Defined in: [src/front-matter.ts:6](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/front-matter.ts#L6)
+Defined in: [src/front-matter.ts:6](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/front-matter.ts#L6)
 
 ## Parameters
 

package/docs/functions/parseYaml.md

@@ -8,7 +8,7 @@
 
 > **parseYaml**(`content`, `options?`): `any`
 
-Defined in: [src/yaml.ts:66](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/yaml.ts#L66)
+Defined in: [src/yaml.ts:66](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/yaml.ts#L66)
 
 Parses a YAML string into a JavaScript object with optional custom tags.
 

package/docs/functions/reControlCharsRegex.md

@@ -8,7 +8,7 @@
 
 > **reControlCharsRegex**(): `RegExp`
 
-Defined in: [src/filename.ts:52](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L52)
+Defined in: [src/filename.ts:52](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/filename.ts#L52)
 
 Returns a new regular expression instance for control characters in a filename with the 'g' flag.
 

package/docs/functions/registerYamlTag.md

@@ -8,7 +8,7 @@
 
 > **registerYamlTag**(`tags`): `void`
 
-Defined in: [src/yaml.ts:34](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/yaml.ts#L34)
+Defined in: [src/yaml.ts:34](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/yaml.ts#L34)
 
 Registers custom YAML tags to be used in parsing and stringifying YAML content.
 
@@ -16,9 +16,9 @@ Registers custom YAML tags to be used in parsing and stringifying YAML content.
 
 ### tags
 
-A single tag or an array of tags to register.
+`"map"` \| `Tags` \| `ScalarTag` \| `CollectionTag` \| `"binary"` \| `"bool"` \| `"float"` \| `"floatExp"` \| `"floatNaN"` \| `"floatTime"` \| `"int"` \| `"intHex"` \| `"intOct"` \| `"intTime"` \| `"merge"` \| `"null"` \| `"omap"` \| `"pairs"` \| `"seq"` \| `"set"` \| `"timestamp"`
 
-`"map"` | `Tags` | `ScalarTag` | `CollectionTag` | `"binary"` | `"bool"` | `"float"` | `"floatExp"` | `"floatNaN"` | `"floatTime"` | `"int"` | `"intHex"` | `"intOct"` | `"intTime"` | `"merge"` | `"null"` | `"omap"` | `"pairs"` | `"seq"` | `"set"` | `"timestamp"`
+A single tag or an array of tags to register.
 
 ## Returns
 

package/docs/functions/removeLeadingEmptyLines.md

@@ -8,7 +8,7 @@
 
 > **removeLeadingEmptyLines**(`text`): `string`
 
-Defined in: [src/remove-leading-empty-lines.ts:16](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/remove-leading-empty-lines.ts#L16)
+Defined in: [src/remove-leading-empty-lines.ts:16](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/remove-leading-empty-lines.ts#L16)
 
 Removes all leading empty lines or "#" comments line from the given string.
 

package/docs/functions/sanitizeFilename.md

@@ -8,7 +8,7 @@
 
 > **sanitizeFilename**(`filename`, `options?`): `string`
 
-Defined in: [src/filename.ts:110](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L110)
+Defined in: [src/filename.ts:110](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/filename.ts#L110)
 
 Sanitizes a given filename by replacing invalid characters with a specified replacement character or a default.
 

package/docs/functions/sanitizeFilepath.md

@@ -8,7 +8,7 @@
 
 > **sanitizeFilepath**(`filepath`, `options?`): `string`
 
-Defined in: [src/filename.ts:178](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/filename.ts#L178)
+Defined in: [src/filename.ts:178](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/filename.ts#L178)
 
 Sanitizes each part of a file path and reassembles it, ensuring the path is valid according to provided options.
 

package/docs/functions/sleep.md

@@ -8,7 +8,7 @@
 
 > **sleep**(`ms`): `Promise`\<`void`\>
 
-Defined in: [src/sleep.ts:12](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/sleep.ts#L12)
+Defined in: [src/sleep.ts:12](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/sleep.ts#L12)
 
 Suspends execution for a specified number of milliseconds
 

package/docs/functions/stringifyYaml.md

@@ -8,7 +8,7 @@
 
 > **stringifyYaml**(`content`, `options?`): `string`
 
-Defined in: [src/yaml.ts:103](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/yaml.ts#L103)
+Defined in: [src/yaml.ts:103](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/yaml.ts#L103)
 
 Converts a JavaScript object into a YAML string with optional custom tags.
 

package/docs/functions/toCamelCase.md

@@ -8,7 +8,7 @@
 
 > **toCamelCase**(`str`): `string`
 
-Defined in: [src/to-camel-case.ts:17](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/to-camel-case.ts#L17)
+Defined in: [src/to-camel-case.ts:17](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/to-camel-case.ts#L17)
 
 Converts a string to camelCase.
 

package/docs/functions/toCapitalCase.md

@@ -8,7 +8,7 @@
 
 > **toCapitalCase**(`str`): `string`
 
-Defined in: [src/to-capital-case.ts:17](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/to-capital-case.ts#L17)
+Defined in: [src/to-capital-case.ts:17](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/to-capital-case.ts#L17)
 
 Converts a string to capital case, where the first letter of each word is capitalized
 and the rest are in lowercase. Words are separated by spaces, hyphens, or underscores.

package/docs/functions/toPascalCase.md

@@ -8,7 +8,7 @@
 
 > **toPascalCase**(`str`): `string`
 
-Defined in: [src/to-pascal-case.ts:16](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/to-pascal-case.ts#L16)
+Defined in: [src/to-pascal-case.ts:16](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/to-pascal-case.ts#L16)
 
 Converts a string to PascalCase.
 

package/docs/functions/traverseFolder.md

@@ -8,7 +8,7 @@
 
 > **traverseFolder**(`directoryPath`, `fileHandler`): `Promise`\<`void`\>
 
-Defined in: [src/traverse-folder.ts:44](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/traverse-folder.ts#L44)
+Defined in: [src/traverse-folder.ts:44](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/traverse-folder.ts#L44)
 
 Traverses a folder asynchronously and applies a handler to each file or directory.
 

package/docs/functions/traverseFolderSync.md

@@ -8,7 +8,7 @@
 
 > **traverseFolderSync**(`directoryPath`, `fileHandler`): `void`
 
-Defined in: [src/traverse-folder.ts:89](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/traverse-folder.ts#L89)
+Defined in: [src/traverse-folder.ts:89](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/traverse-folder.ts#L89)
 
 Traverses a folder synchronously and applies a handler to each file or directory.
 

package/docs/functions/yieldExec.md

@@ -8,7 +8,7 @@
 
 > **yieldExec**(): `Promise`\<`void`\>
 
-Defined in: [src/sleep.ts:28](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/sleep.ts#L28)
+Defined in: [src/sleep.ts:28](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/sleep.ts#L28)
 
 Yields execution control to the event loop, allowing pending I/O operations
 and scheduled tasks to run before continuing.

package/docs/interfaces/BinarySemaphoreAcquireOptions.md

@@ -6,7 +6,9 @@
 
 # Interface: BinarySemaphoreAcquireOptions
 
-Defined in: [src/async-semaphore.ts:28](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L28)
+Defined in: [src/async-semaphore.ts:70](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-semaphore.ts#L70)
+
+获取信号量时的选项。
 
 ## Extended by
 
@@ -14,12 +16,17 @@ Defined in: [src/async-semaphore.ts:28](https://github.com/isdk/util.js/blob/30c
 
 ## Indexable
 
-\[`n`: `string`\]: `any`
+> \[`n`: `string`\]: `any`
+
+允许扩展其他自定义选项。
 
 ## Properties
 
 ### signal?
 
-> `optional` **signal**: `AbortSignal`
+> `optional` **signal?**: `AbortSignal`
+
+Defined in: [src/async-semaphore.ts:75](https://github.com/isdk/util.js/blob/c98bd1bf94d1b1dc8d01c6b9a6fc50b4beec5c62/src/async-semaphore.ts#L75)
 
-Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/30c54a8a455a9593000448de2a45f94a197d73de/src/async-semaphore.ts#L29)
+可选的 AbortSignal，用于取消获取操作。
+如果在获取到令牌前信号被中止，`acquire` 返回的 Promise 将被拒绝并抛出 `AbortError`。