@isdk/util 0.3.4 → 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.
- package/dist/index.d.mts +111 -1
- package/dist/index.d.ts +111 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/classes/BinarySemaphore.md +25 -25
- package/docs/classes/ConfigFile.md +6 -6
- package/docs/classes/Deque.md +13 -13
- package/docs/classes/IntSet.md +12 -12
- package/docs/classes/Semaphore.md +26 -26
- package/docs/classes/SignalGate.md +9 -9
- package/docs/functions/RateLimit.md +1 -1
- package/docs/functions/arrayHasAll.md +1 -1
- package/docs/functions/extNameLevel.md +1 -1
- package/docs/functions/filenameReservedRegex.md +1 -1
- package/docs/functions/findPort.md +1 -1
- package/docs/functions/getMultiLevelExtname.md +1 -1
- package/docs/functions/glob.md +1 -1
- package/docs/functions/isStringIn.md +1 -1
- package/docs/functions/isValidFilename.md +1 -1
- package/docs/functions/isValidFilepath.md +1 -1
- package/docs/functions/normalizeIncludeFiles.md +1 -1
- package/docs/functions/omitDeepBy.md +125 -0
- package/docs/functions/omitEmptyDeep.md +47 -0
- package/docs/functions/parseFrontMatter.md +1 -1
- package/docs/functions/parseYaml.md +1 -1
- package/docs/functions/reControlCharsRegex.md +1 -1
- package/docs/functions/registerYamlTag.md +1 -1
- package/docs/functions/removeLeadingEmptyLines.md +1 -1
- package/docs/functions/sanitizeFilename.md +1 -1
- package/docs/functions/sanitizeFilepath.md +1 -1
- package/docs/functions/sleep.md +1 -1
- package/docs/functions/stringifyYaml.md +1 -1
- package/docs/functions/toCamelCase.md +1 -1
- package/docs/functions/toCapitalCase.md +1 -1
- package/docs/functions/toPascalCase.md +1 -1
- package/docs/functions/traverseFolder.md +1 -1
- package/docs/functions/traverseFolderSync.md +1 -1
- package/docs/functions/yieldExec.md +1 -1
- package/docs/globals.md +2 -0
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
- package/docs/interfaces/IncludeFiles.md +3 -3
- package/docs/interfaces/LoadConfigFileOptions.md +3 -3
- package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
- package/docs/interfaces/SemaphoreOptions.md +7 -7
- package/docs/interfaces/SemaphoreTaskItem.md +5 -5
- package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/type-aliases/StringifyFunc.md +1 -1
- package/docs/type-aliases/TraverseFolderHandler.md +1 -1
- package/docs/type-aliases/TraverseFolderSyncHandler.md +1 -1
- package/docs/variables/DefaultAllTextFiles.md +1 -1
- package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/variables/FilenameReservedRegex.md +1 -1
- package/docs/variables/WindowsReservedNameRegex.md +1 -1
- package/package.json +7 -5
|
@@ -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/
|
|
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
|
|
|
@@ -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/
|
|
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/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/
|
|
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/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/
|
|
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/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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@isdk/util",
|
|
3
3
|
"description": "a set of utility functions",
|
|
4
|
-
"version": "0.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": {
|
|
@@ -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": "^
|
|
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": "^
|
|
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.
|
|
30
|
+
"typedoc-plugin-markdown": "^4.10.0",
|
|
29
31
|
"typescript": "^5.7.3",
|
|
30
|
-
"typescript-eslint": "^8.
|
|
32
|
+
"typescript-eslint": "^8.55.0",
|
|
31
33
|
"vite": "^7.3.1",
|
|
32
34
|
"vitest": "^4.0.18"
|
|
33
35
|
},
|