@isdk/util 0.3.4 → 0.3.6

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 +27 -27
  6. package/docs/classes/ConfigFile.md +6 -6
  7. package/docs/classes/Deque.md +13 -13
  8. package/docs/classes/IntSet.md +14 -14
  9. package/docs/classes/Semaphore.md +26 -26
  10. package/docs/classes/SignalGate.md +9 -9
  11. package/docs/functions/RateLimit.md +3 -3
  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 +3 -3
  16. package/docs/functions/getMultiLevelExtname.md +3 -3
  17. package/docs/functions/glob.md +1 -1
  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 +1 -1
  22. package/docs/functions/omitDeepBy.md +125 -0
  23. package/docs/functions/omitEmptyDeep.md +51 -0
  24. package/docs/functions/parseFrontMatter.md +3 -3
  25. package/docs/functions/parseYaml.md +1 -1
  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 +3 -3
  30. package/docs/functions/sanitizeFilepath.md +3 -3
  31. package/docs/functions/sleep.md +1 -1
  32. package/docs/functions/stringifyYaml.md +1 -1
  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 +5 -5
  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 +7 -5
package/docs/interfaces/SemaphoreOptions.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L42)
9
+ Defined in: [src/async-semaphore.ts:42](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
18
18
 
19
19
  > `optional` **capacity**: `number`
20
20
 
21
- Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L25)
21
+ Defined in: [src/async-semaphore.ts:25](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
30
30
 
31
31
  > `optional` **initFn**: () => `any`
32
32
 
33
- Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L22)
33
+ Defined in: [src/async-semaphore.ts:22](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
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/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L44)
49
+ Defined in: [src/async-semaphore.ts:44](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
54
54
 
55
55
  > `optional` **maxConcurrency**: `number`
56
56
 
57
- Defined in: [src/async-semaphore.ts:43](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L43)
57
+ Defined in: [src/async-semaphore.ts:43](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
62
62
 
63
63
  > `optional` **pauseFn**: () => `void`
64
64
 
65
- Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L23)
65
+ Defined in: [src/async-semaphore.ts:23](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
78
78
 
79
79
  > `optional` **resumeFn**: () => `void`
80
80
 
81
- Defined in: [src/async-semaphore.ts:24](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L24)
81
+ Defined in: [src/async-semaphore.ts:24](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L24)
82
82
 
83
83
  #### Returns
84
84
 
package/docs/interfaces/SemaphoreTaskItem.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L52)
9
+ Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L52)
10
10
 
11
11
  ## Extends
12
12
 
@@ -22,7 +22,7 @@ Defined in: [src/async-semaphore.ts:52](https://github.com/isdk/util.js/blob/124
22
22
 
23
23
  > **reject**: (`reason?`) => `void`
24
24
 
25
- Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L54)
25
+ Defined in: [src/async-semaphore.ts:54](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
40
40
 
41
41
  > **resolve**: (`value`) => `void`
42
42
 
43
- Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L53)
43
+ Defined in: [src/async-semaphore.ts:53](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
58
58
 
59
59
  > `optional` **signal**: `AbortSignal`
60
60
 
61
- Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L29)
61
+ Defined in: [src/async-semaphore.ts:29](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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/124
70
70
 
71
71
  > `optional` **token**: `any`
72
72
 
73
- Defined in: [src/async-semaphore.ts:55](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L55)
73
+ Defined in: [src/async-semaphore.ts:55](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L55)
package/docs/type-aliases/SemaphoreIsReadyFuncType.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L11)
11
+ Defined in: [src/async-semaphore.ts:11](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L11)
12
12
 
13
13
  ## Returns
14
14
 
package/docs/type-aliases/StringifyFunc.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/config-file.ts#L18)
11
+ Defined in: [src/config-file.ts:18](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/config-file.ts#L18)
12
12
 
13
13
  ## Parameters
14
14
 
package/docs/type-aliases/TraverseFolderHandler.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/traverse-folder.ts#L11)
11
+ Defined in: [src/traverse-folder.ts:11](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/traverse-folder.ts#L11)
12
12
 
13
13
  A handler function for asynchronous folder traversal.
14
14
 
package/docs/type-aliases/TraverseFolderSyncHandler.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/traverse-folder.ts#L18)
11
+ Defined in: [src/traverse-folder.ts:18](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/traverse-folder.ts#L18)
12
12
 
13
13
  A handler function for synchronous folder traversal.
14
14
 
package/docs/variables/DefaultAllTextFiles.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/include-files.ts#L1)
11
+ Defined in: [src/include-files.ts:1](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/include-files.ts#L1)
package/docs/variables/DefaultAsyncSemaphoreCapacity.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L9)
11
+ Defined in: [src/async-semaphore.ts:9](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/async-semaphore.ts#L9)
package/docs/variables/FilenameReservedRegex.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L8)
11
+ Defined in: [src/filename.ts:8](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/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.
package/docs/variables/WindowsReservedNameRegex.md CHANGED
@@ -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/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L13)
11
+ Defined in: [src/filename.ts:13](https://github.com/isdk/util.js/blob/61856e5b1bbb9d976eeb1fdfe1a4d88a26997dec/src/filename.ts#L13)
12
12
 
13
13
  Regular expression pattern for reserved names on Windows systems.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@isdk/util",
3
3
  "description": "a set of utility functions",
4
- "version": "0.3.4",
4
+ "version": "0.3.6",
5
5
  "author": "Riceball LEE @snowyu",
6
6
  "bugs": "https://github.com/isdk/util.js/issues",
7
7
  "dependencies": {
@@ -9,25 +9,27 @@
9
9
  "@isdk/glob": "^0.1.1",
10
10
  "events-ex": "^2.1.1",
11
11
  "load-config-file": "^2.1.0",
12
+ "lodash-es": "^4.17.23",
12
13
  "util-ex": "^2.5.1",
13
14
  "yaml": "^2.8.2"
14
15
  },
15
16
  "devDependencies": {
16
17
  "@eslint/eslintrc": "^3.3.3",
17
- "@eslint/js": "^9.39.2",
18
+ "@eslint/js": "^10.0.1",
18
19
  "@types/chai": "^5",
19
20
  "@types/jest": "^30.0.0",
21
+ "@types/lodash-es": "^4.17.12",
20
22
  "@types/node": "^25",
21
- "eslint": "^9",
23
+ "eslint": "^10",
22
24
  "eslint-config-prettier": "^10",
23
25
  "shx": "^0.4.0",
24
26
  "terser": "^5.46.0",
25
27
  "tsup": "^8.5.1",
26
28
  "tsx": "^4.21.0",
27
29
  "typedoc": "^0.28.16",
28
- "typedoc-plugin-markdown": "^4.9.0",
30
+ "typedoc-plugin-markdown": "^4.10.0",
29
31
  "typescript": "^5.7.3",
30
- "typescript-eslint": "^8.54.0",
32
+ "typescript-eslint": "^8.55.0",
31
33
  "vite": "^7.3.1",
32
34
  "vitest": "^4.0.18"
33
35
  },