@isdk/util 0.3.3 → 0.3.5

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 (57) hide show
  1. package/dist/index.d.mts +111 -1
  2. package/dist/index.d.ts +111 -1
  3. package/dist/index.js +1 -1
  4. package/dist/index.mjs +1 -1
  5. package/docs/classes/BinarySemaphore.md +37 -37
  6. package/docs/classes/ConfigFile.md +9 -9
  7. package/docs/classes/Deque.md +56 -56
  8. package/docs/classes/IntSet.md +12 -12
  9. package/docs/classes/Semaphore.md +38 -38
  10. package/docs/classes/SignalGate.md +12 -12
  11. package/docs/functions/RateLimit.md +2 -2
  12. package/docs/functions/arrayHasAll.md +1 -1
  13. package/docs/functions/extNameLevel.md +1 -1
  14. package/docs/functions/filenameReservedRegex.md +1 -1
  15. package/docs/functions/findPort.md +1 -1
  16. package/docs/functions/getMultiLevelExtname.md +1 -1
  17. package/docs/functions/glob.md +3 -3
  18. package/docs/functions/isStringIn.md +1 -1
  19. package/docs/functions/isValidFilename.md +1 -1
  20. package/docs/functions/isValidFilepath.md +1 -1
  21. package/docs/functions/normalizeIncludeFiles.md +2 -2
  22. package/docs/functions/omitDeepBy.md +125 -0
  23. package/docs/functions/omitEmptyDeep.md +47 -0
  24. package/docs/functions/parseFrontMatter.md +1 -1
  25. package/docs/functions/parseYaml.md +2 -2
  26. package/docs/functions/reControlCharsRegex.md +1 -1
  27. package/docs/functions/registerYamlTag.md +1 -1
  28. package/docs/functions/removeLeadingEmptyLines.md +1 -1
  29. package/docs/functions/sanitizeFilename.md +1 -1
  30. package/docs/functions/sanitizeFilepath.md +1 -1
  31. package/docs/functions/sleep.md +1 -1
  32. package/docs/functions/stringifyYaml.md +2 -2
  33. package/docs/functions/toCamelCase.md +1 -1
  34. package/docs/functions/toCapitalCase.md +1 -1
  35. package/docs/functions/toPascalCase.md +1 -1
  36. package/docs/functions/traverseFolder.md +1 -1
  37. package/docs/functions/traverseFolderSync.md +1 -1
  38. package/docs/functions/yieldExec.md +1 -1
  39. package/docs/globals.md +2 -0
  40. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
  41. package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
  42. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
  43. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
  44. package/docs/interfaces/IncludeFiles.md +3 -3
  45. package/docs/interfaces/LoadConfigFileOptions.md +3 -3
  46. package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
  47. package/docs/interfaces/SemaphoreOptions.md +7 -7
  48. package/docs/interfaces/SemaphoreTaskItem.md +6 -6
  49. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
  50. package/docs/type-aliases/StringifyFunc.md +1 -1
  51. package/docs/type-aliases/TraverseFolderHandler.md +1 -1
  52. package/docs/type-aliases/TraverseFolderSyncHandler.md +1 -1
  53. package/docs/variables/DefaultAllTextFiles.md +1 -1
  54. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  55. package/docs/variables/FilenameReservedRegex.md +1 -1
  56. package/docs/variables/WindowsReservedNameRegex.md +1 -1
  57. package/package.json +21 -19
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **parseFrontMatter**(`value`, `delimiter`): `object`
10
10
 
11
- Defined in: [src/front-matter.ts:6](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/front-matter.ts#L6)
11
+ Defined in: [src/front-matter.ts:6](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/front-matter.ts#L6)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: parseYaml()
8
8
 
9
- > **parseYaml**(`content`, `options`?): `any`
9
+ > **parseYaml**(`content`, `options?`): `any`
10
10
 
11
- Defined in: [src/yaml.ts:51](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/yaml.ts#L51)
11
+ Defined in: [src/yaml.ts:51](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/yaml.ts#L51)
12
12
 
13
13
  Parses a YAML string into a JavaScript object with optional custom tags.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **reControlCharsRegex**(): `RegExp`
10
10
 
11
- Defined in: [src/filename.ts:50](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L50)
11
+ Defined in: [src/filename.ts:50](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/filename.ts#L50)
12
12
 
13
13
  Returns a new regular expression instance for control characters in a filename with the 'g' flag.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **registerYamlTag**(`tags`): `void`
10
10
 
11
- Defined in: [src/yaml.ts:23](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/yaml.ts#L23)
11
+ Defined in: [src/yaml.ts:23](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/yaml.ts#L23)
12
12
 
13
13
  Registers custom YAML tags to be used in parsing and stringifying YAML content.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **removeLeadingEmptyLines**(`text`): `string`
10
10
 
11
- Defined in: [src/remove-leading-empty-lines.ts:16](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/remove-leading-empty-lines.ts#L16)
11
+ Defined in: [src/remove-leading-empty-lines.ts:16](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/remove-leading-empty-lines.ts#L16)
12
12
 
13
13
  Removes all leading empty lines or "#" comments line from the given string.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **sanitizeFilename**(`filename`, `options`): `string`
10
10
 
11
- Defined in: [src/filename.ts:97](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L97)
11
+ Defined in: [src/filename.ts:97](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/filename.ts#L97)
12
12
 
13
13
  Sanitizes a given filename by replacing invalid characters with a specified replacement character or a default.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **sanitizeFilepath**(`filepath`, `options`): `string`
10
10
 
11
- Defined in: [src/filename.ts:149](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L149)
11
+ Defined in: [src/filename.ts:149](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/filename.ts#L149)
12
12
 
13
13
  Sanitizes each part of a file path and reassembles it, ensuring the path is valid according to provided options.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **sleep**(`ms`): `Promise`\<`void`\>
10
10
 
11
- Defined in: [src/sleep.ts:12](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/sleep.ts#L12)
11
+ Defined in: [src/sleep.ts:12](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/sleep.ts#L12)
12
12
 
13
13
  Suspends execution for a specified number of milliseconds
14
14
 
@@ -6,9 +6,9 @@
6
6
 
7
7
  # Function: stringifyYaml()
8
8
 
9
- > **stringifyYaml**(`content`, `options`?): `string`
9
+ > **stringifyYaml**(`content`, `options?`): `string`
10
10
 
11
- Defined in: [src/yaml.ts:85](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/yaml.ts#L85)
11
+ Defined in: [src/yaml.ts:85](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/yaml.ts#L85)
12
12
 
13
13
  Converts a JavaScript object into a YAML string with optional custom tags.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **toCamelCase**(`str`): `string`
10
10
 
11
- Defined in: [src/to-camel-case.ts:17](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/to-camel-case.ts#L17)
11
+ Defined in: [src/to-camel-case.ts:17](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/to-camel-case.ts#L17)
12
12
 
13
13
  Converts a string to camelCase.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **toCapitalCase**(`str`): `string`
10
10
 
11
- Defined in: [src/to-capital-case.ts:17](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/to-capital-case.ts#L17)
11
+ Defined in: [src/to-capital-case.ts:17](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/to-capital-case.ts#L17)
12
12
 
13
13
  Converts a string to capital case, where the first letter of each word is capitalized
14
14
  and the rest are in lowercase. Words are separated by spaces, hyphens, or underscores.
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **toPascalCase**(`str`): `string`
10
10
 
11
- Defined in: [src/to-pascal-case.ts:16](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/to-pascal-case.ts#L16)
11
+ Defined in: [src/to-pascal-case.ts:16](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/to-pascal-case.ts#L16)
12
12
 
13
13
  Converts a string to PascalCase.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **traverseFolder**(`directoryPath`, `fileHandler`): `Promise`\<`void`\>
10
10
 
11
- Defined in: [src/traverse-folder.ts:38](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/traverse-folder.ts#L38)
11
+ Defined in: [src/traverse-folder.ts:38](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/traverse-folder.ts#L38)
12
12
 
13
13
  Traverses a folder asynchronously and applies a handler to each file or directory.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **traverseFolderSync**(`directoryPath`, `fileHandler`): `void`
10
10
 
11
- Defined in: [src/traverse-folder.ts:76](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/traverse-folder.ts#L76)
11
+ Defined in: [src/traverse-folder.ts:76](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/traverse-folder.ts#L76)
12
12
 
13
13
  Traverses a folder synchronously and applies a handler to each file or directory.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **yieldExec**(): `Promise`\<`void`\>
10
10
 
11
- Defined in: [src/sleep.ts:28](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/sleep.ts#L28)
11
+ Defined in: [src/sleep.ts:28](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/sleep.ts#L28)
12
12
 
13
13
  Yields execution control to the event loop, allowing pending I/O operations
14
14
  and scheduled tasks to run before continuing.
package/docs/globals.md CHANGED
@@ -51,6 +51,8 @@
51
51
  - [isValidFilename](functions/isValidFilename.md)
52
52
  - [isValidFilepath](functions/isValidFilepath.md)
53
53
  - [normalizeIncludeFiles](functions/normalizeIncludeFiles.md)
54
+ - [omitDeepBy](functions/omitDeepBy.md)
55
+ - [omitEmptyDeep](functions/omitEmptyDeep.md)
54
56
  - [parseFrontMatter](functions/parseFrontMatter.md)
55
57
  - [parseYaml](functions/parseYaml.md)
56
58
  - [RateLimit](functions/RateLimit.md)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BinarySemaphoreAcquireOptions
8
8
 
9
- Defined in: [src/async-semaphore.ts:28](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L28)
9
+ Defined in: [src/async-semaphore.ts:28](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L28)
10
10
 
11
11
  ## Extended by
12
12
 
@@ -22,4 +22,4 @@ Defined in: [src/async-semaphore.ts:28](https://github.com/isdk/util.js/blob/f6a
22
22
 
23
23
  > `optional` **signal**: `AbortSignal`
24
24
 
25
- Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L29)
25
+ Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L29)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BinarySemaphoreOptions
8
8
 
9
- Defined in: [src/async-semaphore.ts:21](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L21)
9
+ Defined in: [src/async-semaphore.ts:21](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L21)
10
10
 
11
11
  ## Extended by
12
12
 
@@ -18,7 +18,7 @@ Defined in: [src/async-semaphore.ts:21](https://github.com/isdk/util.js/blob/f6a
18
18
 
19
19
  > `optional` **capacity**: `number`
20
20
 
21
- Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L25)
21
+ Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L25)
22
22
 
23
23
  ***
24
24
 
@@ -26,7 +26,7 @@ Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/f6a
26
26
 
27
27
  > `optional` **initFn**: () => `any`
28
28
 
29
- Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L22)
29
+ Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L22)
30
30
 
31
31
  #### Returns
32
32
 
@@ -38,7 +38,7 @@ Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/f6a
38
38
 
39
39
  > `optional` **pauseFn**: () => `void`
40
40
 
41
- Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L23)
41
+ Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L23)
42
42
 
43
43
  #### Returns
44
44
 
@@ -50,7 +50,7 @@ Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/f6a
50
50
 
51
51
  > `optional` **resumeFn**: () => `void`
52
52
 
53
- Defined in: [src/async-semaphore.ts:24](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L24)
53
+ Defined in: [src/async-semaphore.ts:24](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L24)
54
54
 
55
55
  #### Returns
56
56
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BinarySemaphoreReleaseOptions
8
8
 
9
- Defined in: [src/async-semaphore.ts:33](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L33)
9
+ Defined in: [src/async-semaphore.ts:33](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L33)
10
10
 
11
11
  ## Extended by
12
12
 
@@ -22,4 +22,4 @@ Defined in: [src/async-semaphore.ts:33](https://github.com/isdk/util.js/blob/f6a
22
22
 
23
23
  > `optional` **token**: `any`
24
24
 
25
- Defined in: [src/async-semaphore.ts:34](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L34)
25
+ Defined in: [src/async-semaphore.ts:34](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L34)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: BinarySemaphoreReleaserFunc()
8
8
 
9
- Defined in: [src/async-semaphore.ts:38](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L38)
9
+ Defined in: [src/async-semaphore.ts:38](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L38)
10
10
 
11
11
  ## Extends
12
12
 
@@ -14,7 +14,7 @@ Defined in: [src/async-semaphore.ts:38](https://github.com/isdk/util.js/blob/f6a
14
14
 
15
15
  > **BinarySemaphoreReleaserFunc**(): `void`
16
16
 
17
- Defined in: [src/async-semaphore.ts:39](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L39)
17
+ Defined in: [src/async-semaphore.ts:39](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L39)
18
18
 
19
19
  ## Returns
20
20
 
@@ -30,7 +30,7 @@ Defined in: [src/async-semaphore.ts:39](https://github.com/isdk/util.js/blob/f6a
30
30
 
31
31
  > `optional` **token**: `any`
32
32
 
33
- Defined in: [src/async-semaphore.ts:34](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L34)
33
+ Defined in: [src/async-semaphore.ts:34](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L34)
34
34
 
35
35
  #### Inherited from
36
36
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: IncludeFiles
8
8
 
9
- Defined in: [src/include-files.ts:6](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/include-files.ts#L6)
9
+ Defined in: [src/include-files.ts:6](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/include-files.ts#L6)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [src/include-files.ts:6](https://github.com/isdk/util.js/blob/f6ac1e
14
14
 
15
15
  > `optional` **exclude**: `string`[]
16
16
 
17
- Defined in: [src/include-files.ts:8](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/include-files.ts#L8)
17
+ Defined in: [src/include-files.ts:8](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/include-files.ts#L8)
18
18
 
19
19
  ***
20
20
 
@@ -22,4 +22,4 @@ Defined in: [src/include-files.ts:8](https://github.com/isdk/util.js/blob/f6ac1e
22
22
 
23
23
  > `optional` **include**: `string`[]
24
24
 
25
- Defined in: [src/include-files.ts:7](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/include-files.ts#L7)
25
+ Defined in: [src/include-files.ts:7](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/include-files.ts#L7)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: LoadConfigFileOptions
8
8
 
9
- Defined in: [src/config-file.ts:20](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L20)
9
+ Defined in: [src/config-file.ts:20](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L20)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [src/config-file.ts:20](https://github.com/isdk/util.js/blob/f6ac1e1
14
14
 
15
15
  > `optional` **externalFile**: `string`
16
16
 
17
- Defined in: [src/config-file.ts:22](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L22)
17
+ Defined in: [src/config-file.ts:22](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L22)
18
18
 
19
19
  ***
20
20
 
@@ -22,4 +22,4 @@ Defined in: [src/config-file.ts:22](https://github.com/isdk/util.js/blob/f6ac1e1
22
22
 
23
23
  > `optional` **extLevel**: `number`
24
24
 
25
- Defined in: [src/config-file.ts:21](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L21)
25
+ Defined in: [src/config-file.ts:21](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L21)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SanitizeFilenameOptions
8
8
 
9
- Defined in: [src/filename.ts:83](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L83)
9
+ Defined in: [src/filename.ts:83](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/filename.ts#L83)
10
10
 
11
11
  ## Properties
12
12
 
@@ -14,7 +14,7 @@ Defined in: [src/filename.ts:83](https://github.com/isdk/util.js/blob/f6ac1e1b24
14
14
 
15
15
  > `optional` **maxLength**: `number`
16
16
 
17
- Defined in: [src/filename.ts:85](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L85)
17
+ Defined in: [src/filename.ts:85](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/filename.ts#L85)
18
18
 
19
19
  ***
20
20
 
@@ -22,4 +22,4 @@ Defined in: [src/filename.ts:85](https://github.com/isdk/util.js/blob/f6ac1e1b24
22
22
 
23
23
  > `optional` **replacement**: `string`
24
24
 
25
- Defined in: [src/filename.ts:84](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L84)
25
+ Defined in: [src/filename.ts:84](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/filename.ts#L84)
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SemaphoreOptions
8
8
 
9
- Defined in: [src/async-semaphore.ts:42](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L42)
9
+ Defined in: [src/async-semaphore.ts:42](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L42)
10
10
 
11
11
  ## Extends
12
12
 
@@ -18,7 +18,7 @@ Defined in: [src/async-semaphore.ts:42](https://github.com/isdk/util.js/blob/f6a
18
18
 
19
19
  > `optional` **capacity**: `number`
20
20
 
21
- Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L25)
21
+ Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L25)
22
22
 
23
23
  #### Inherited from
24
24
 
@@ -30,7 +30,7 @@ Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/f6a
30
30
 
31
31
  > `optional` **initFn**: () => `any`
32
32
 
33
- Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L22)
33
+ Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L22)
34
34
 
35
35
  #### Returns
36
36
 
@@ -46,7 +46,7 @@ Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/f6a
46
46
 
47
47
  > `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
48
48
 
49
- Defined in: [src/async-semaphore.ts:44](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L44)
49
+ Defined in: [src/async-semaphore.ts:44](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L44)
50
50
 
51
51
  ***
52
52
 
@@ -54,7 +54,7 @@ Defined in: [src/async-semaphore.ts:44](https://github.com/isdk/util.js/blob/f6a
54
54
 
55
55
  > `optional` **maxConcurrency**: `number`
56
56
 
57
- Defined in: [src/async-semaphore.ts:43](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L43)
57
+ Defined in: [src/async-semaphore.ts:43](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L43)
58
58
 
59
59
  ***
60
60
 
@@ -62,7 +62,7 @@ Defined in: [src/async-semaphore.ts:43](https://github.com/isdk/util.js/blob/f6a
62
62
 
63
63
  > `optional` **pauseFn**: () => `void`
64
64
 
65
- Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L23)
65
+ Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L23)
66
66
 
67
67
  #### Returns
68
68
 
@@ -78,7 +78,7 @@ Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/f6a
78
78
 
79
79
  > `optional` **resumeFn**: () => `void`
80
80
 
81
- Defined in: [src/async-semaphore.ts:24](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L24)
81
+ Defined in: [src/async-semaphore.ts:24](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L24)
82
82
 
83
83
  #### Returns
84
84
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Interface: SemaphoreTaskItem
8
8
 
9
- Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L52)
9
+ Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L52)
10
10
 
11
11
  ## Extends
12
12
 
@@ -20,9 +20,9 @@ Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/f6a
20
20
 
21
21
  ### reject()
22
22
 
23
- > **reject**: (`reason`?) => `void`
23
+ > **reject**: (`reason?`) => `void`
24
24
 
25
- Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L54)
25
+ Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L54)
26
26
 
27
27
  #### Parameters
28
28
 
@@ -40,7 +40,7 @@ Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/f6a
40
40
 
41
41
  > **resolve**: (`value`) => `void`
42
42
 
43
- Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L53)
43
+ Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L53)
44
44
 
45
45
  #### Parameters
46
46
 
@@ -58,7 +58,7 @@ Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/f6a
58
58
 
59
59
  > `optional` **signal**: `AbortSignal`
60
60
 
61
- Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L29)
61
+ Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L29)
62
62
 
63
63
  #### Inherited from
64
64
 
@@ -70,4 +70,4 @@ Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/f6a
70
70
 
71
71
  > `optional` **token**: `any`
72
72
 
73
- Defined in: [src/async-semaphore.ts:55](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L55)
73
+ Defined in: [src/async-semaphore.ts:55](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L55)
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **SemaphoreIsReadyFuncType** = () => `Promise`\<`boolean`\> \| `boolean`
10
10
 
11
- Defined in: [src/async-semaphore.ts:11](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L11)
11
+ Defined in: [src/async-semaphore.ts:11](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L11)
12
12
 
13
13
  ## Returns
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **StringifyFunc** = (`content`) => `string`
10
10
 
11
- Defined in: [src/config-file.ts:18](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L18)
11
+ Defined in: [src/config-file.ts:18](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L18)
12
12
 
13
13
  ## Parameters
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **TraverseFolderHandler** = (`filePath`, `entry`) => `boolean` \| `void` \| `Promise`\<`boolean` \| `void`\>
10
10
 
11
- Defined in: [src/traverse-folder.ts:11](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/traverse-folder.ts#L11)
11
+ Defined in: [src/traverse-folder.ts:11](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/traverse-folder.ts#L11)
12
12
 
13
13
  A handler function for asynchronous folder traversal.
14
14
 
@@ -8,7 +8,7 @@
8
8
 
9
9
  > **TraverseFolderSyncHandler** = (`filePath`, `entry`) => `boolean` \| `void`
10
10
 
11
- Defined in: [src/traverse-folder.ts:18](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/traverse-folder.ts#L18)
11
+ Defined in: [src/traverse-folder.ts:18](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/traverse-folder.ts#L18)
12
12
 
13
13
  A handler function for synchronous folder traversal.
14
14
 
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **DefaultAllTextFiles**: `string`[]
10
10
 
11
- Defined in: [src/include-files.ts:1](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/include-files.ts#L1)
11
+ Defined in: [src/include-files.ts:1](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/include-files.ts#L1)
@@ -8,4 +8,4 @@
8
8
 
9
9
  > `const` **DefaultAsyncSemaphoreCapacity**: `32` = `32`
10
10
 
11
- Defined in: [src/async-semaphore.ts:9](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L9)
11
+ Defined in: [src/async-semaphore.ts:9](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/async-semaphore.ts#L9)
@@ -8,7 +8,7 @@
8
8
 
9
9
  > `const` **FilenameReservedRegex**: `RegExp`
10
10
 
11
- Defined in: [src/filename.ts:8](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L8)
11
+ Defined in: [src/filename.ts:8](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/filename.ts#L8)
12
12
 
13
13
  Regular expression pattern for reserved characters in a filename.
14
14
  do not use /g global option here: when the regex is executed multiple times, it will always begin where it left off last time.
@@ -8,6 +8,6 @@
8
8
 
9
9
  > `const` **WindowsReservedNameRegex**: `RegExp`
10
10
 
11
- Defined in: [src/filename.ts:13](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L13)
11
+ Defined in: [src/filename.ts:13](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/filename.ts#L13)
12
12
 
13
13
  Regular expression pattern for reserved names on Windows systems.
package/package.json CHANGED
@@ -1,35 +1,37 @@
1
1
  {
2
2
  "name": "@isdk/util",
3
3
  "description": "a set of utility functions",
4
- "version": "0.3.3",
4
+ "version": "0.3.5",
5
5
  "author": "Riceball LEE @snowyu",
6
6
  "bugs": "https://github.com/isdk/util.js/issues",
7
7
  "dependencies": {
8
- "@isdk/common-error": "^0.1.4",
9
- "@isdk/glob": "^0.1.0",
8
+ "@isdk/common-error": "^0.2.0",
9
+ "@isdk/glob": "^0.1.1",
10
10
  "events-ex": "^2.1.1",
11
11
  "load-config-file": "^2.1.0",
12
- "util-ex": "^2.4.0",
13
- "yaml": "^2.7.0"
12
+ "lodash-es": "^4.17.23",
13
+ "util-ex": "^2.5.1",
14
+ "yaml": "^2.8.2"
14
15
  },
15
16
  "devDependencies": {
16
- "@eslint/eslintrc": "^3.3.1",
17
- "@eslint/js": "^9.23.0",
17
+ "@eslint/eslintrc": "^3.3.3",
18
+ "@eslint/js": "^10.0.1",
18
19
  "@types/chai": "^5",
19
- "@types/jest": "^29.5.14",
20
- "@types/node": "^18",
21
- "eslint": "^9",
20
+ "@types/jest": "^30.0.0",
21
+ "@types/lodash-es": "^4.17.12",
22
+ "@types/node": "^25",
23
+ "eslint": "^10",
22
24
  "eslint-config-prettier": "^10",
23
- "shx": "^0.3.3",
24
- "terser": "^5.39.0",
25
- "tsup": "^8.4.0",
26
- "tsx": "^4.19.3",
27
- "typedoc": "^0.28.1",
28
- "typedoc-plugin-markdown": "^4.6.0",
25
+ "shx": "^0.4.0",
26
+ "terser": "^5.46.0",
27
+ "tsup": "^8.5.1",
28
+ "tsx": "^4.21.0",
29
+ "typedoc": "^0.28.16",
30
+ "typedoc-plugin-markdown": "^4.10.0",
29
31
  "typescript": "^5.7.3",
30
- "typescript-eslint": "^8.28.0",
31
- "vite": "^6.2.3",
32
- "vitest": "^3.0.9"
32
+ "typescript-eslint": "^8.55.0",
33
+ "vite": "^7.3.1",
34
+ "vitest": "^4.0.18"
33
35
  },
34
36
  "engines": {
35
37
  "node": ">=18.0.0"