@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
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ConfigFile
8
8
 
9
- Defined in: [src/config-file.ts:46](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L46)
9
+ Defined in: [src/config-file.ts:46](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L46)
10
10
 
11
11
  Represents a configuration file utility class that provides methods to load and save configuration files.
12
12
  It supports multiple file formats such as YAML, JSON, etc., by registering corresponding parsers and stringifiers.
@@ -45,7 +45,7 @@ console.log(config); // Output: { key: 'value' }
45
45
 
46
46
  > `static` **stringifys**: `Record`\<`string`, [`StringifyFunc`](../type-aliases/StringifyFunc.md)\> = `{}`
47
47
 
48
- Defined in: [src/config-file.ts:50](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L50)
48
+ Defined in: [src/config-file.ts:50](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L50)
49
49
 
50
50
  A record of registered stringify functions for different file extensions.
51
51
 
@@ -53,9 +53,9 @@ A record of registered stringify functions for different file extensions.
53
53
 
54
54
  ### existsSync()
55
55
 
56
- > `static` **existsSync**(`filename`, `options`?): `boolean`
56
+ > `static` **existsSync**(`filename`, `options?`): `boolean`
57
57
 
58
- Defined in: [src/config-file.ts:132](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L132)
58
+ Defined in: [src/config-file.ts:132](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L132)
59
59
 
60
60
  Checks if a configuration file exists at the specified path.
61
61
 
@@ -102,9 +102,9 @@ console.log(existsWithExt); // true or false
102
102
 
103
103
  ### loadSync()
104
104
 
105
- > `static` **loadSync**(`filename`, `options`?): `any`
105
+ > `static` **loadSync**(`filename`, `options?`): `any`
106
106
 
107
- Defined in: [src/config-file.ts:85](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L85)
107
+ Defined in: [src/config-file.ts:85](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L85)
108
108
 
109
109
  Loads a configuration file based on the provided filename and options.
110
110
 
@@ -141,7 +141,7 @@ console.log(config); // Output: { key: 'value' }
141
141
 
142
142
  > `static` **register**(`extname`, `parser`, `stringify`): `void`
143
143
 
144
- Defined in: [src/config-file.ts:64](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L64)
144
+ Defined in: [src/config-file.ts:64](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L64)
145
145
 
146
146
  Registers a parser and stringifier for specific file extensions.
147
147
 
@@ -179,9 +179,9 @@ ConfigFile.register(['.json'], JSON.parse, (obj) => JSON.stringify(obj, null, 2)
179
179
 
180
180
  ### saveSync()
181
181
 
182
- > `static` **saveSync**(`filename`, `config`, `options`?): `string`
182
+ > `static` **saveSync**(`filename`, `config`, `options?`): `string`
183
183
 
184
- Defined in: [src/config-file.ts:102](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/config-file.ts#L102)
184
+ Defined in: [src/config-file.ts:102](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/config-file.ts#L102)
185
185
 
186
186
  Saves a configuration object to a file with the specified filename and options.
187
187
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: Deque\<T\>
8
8
 
9
- Defined in: [src/deque.ts:31](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L31)
9
+ Defined in: [src/deque.ts:31](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L31)
10
10
 
11
11
  ## Extends
12
12
 
@@ -26,9 +26,9 @@ Defined in: [src/deque.ts:31](https://github.com/isdk/util.js/blob/f6ac1e1b241d0
26
26
 
27
27
  ### Constructor
28
28
 
29
- > **new Deque**\<`T`\>(`capacity`?, `disableAutoResize`?): `Deque`\<`T`\>
29
+ > **new Deque**\<`T`\>(`capacity?`, `disableAutoResize?`): `Deque`\<`T`\>
30
30
 
31
- Defined in: [src/deque.ts:37](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L37)
31
+ Defined in: [src/deque.ts:37](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L37)
32
32
 
33
33
  #### Parameters
34
34
 
@@ -61,7 +61,7 @@ when they will be absent when used in a 'with' statement.
61
61
 
62
62
  #### Index Signature
63
63
 
64
- \[`key`: `number`\]: `undefined` \| `boolean`
64
+ \[`key`: `number`\]: `boolean` \| `undefined`
65
65
 
66
66
  #### \[iterator\]?
67
67
 
@@ -224,7 +224,7 @@ Gets or sets the length of the array. This is a number one higher than the highe
224
224
 
225
225
  #### Inherited from
226
226
 
227
- `Array.length`
227
+ `Deque`.[`length`](#length)
228
228
 
229
229
  ***
230
230
 
@@ -246,7 +246,7 @@ Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/li
246
246
 
247
247
  > **get** **size**(): `number`
248
248
 
249
- Defined in: [src/deque.ts:172](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L172)
249
+ Defined in: [src/deque.ts:172](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L172)
250
250
 
251
251
  Gets the number of elements in the deque.
252
252
 
@@ -289,7 +289,7 @@ Iterator
289
289
 
290
290
  ### at()
291
291
 
292
- > **at**(`index`): `undefined` \| `T`
292
+ > **at**(`index`): `T` \| `undefined`
293
293
 
294
294
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2022.array.d.ts:24
295
295
 
@@ -305,7 +305,7 @@ The zero-based index of the desired code unit. A negative index will count back
305
305
 
306
306
  #### Returns
307
307
 
308
- `undefined` \| `T`
308
+ `T` \| `undefined`
309
309
 
310
310
  #### Inherited from
311
311
 
@@ -317,7 +317,7 @@ The zero-based index of the desired code unit. A negative index will count back
317
317
 
318
318
  > **clear**(): `void`
319
319
 
320
- Defined in: [src/deque.ts:206](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L206)
320
+ Defined in: [src/deque.ts:206](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L206)
321
321
 
322
322
  #### Returns
323
323
 
@@ -381,7 +381,7 @@ Additional arrays and/or items to add to the end of the array.
381
381
 
382
382
  ### copyWithin()
383
383
 
384
- > **copyWithin**(`target`, `start`, `end`?): `this`
384
+ > **copyWithin**(`target`, `start`, `end?`): `this`
385
385
 
386
386
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:62
387
387
 
@@ -442,7 +442,7 @@ Returns an iterable of key, value pairs for every entry in the array
442
442
 
443
443
  #### Call Signature
444
444
 
445
- > **every**\<`S`\>(`predicate`, `thisArg`?): `this is S[]`
445
+ > **every**\<`S`\>(`predicate`, `thisArg?`): `this is S[]`
446
446
 
447
447
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1433
448
448
 
@@ -481,7 +481,7 @@ If thisArg is omitted, undefined is used as the this value.
481
481
 
482
482
  #### Call Signature
483
483
 
484
- > **every**(`predicate`, `thisArg`?): `boolean`
484
+ > **every**(`predicate`, `thisArg?`): `boolean`
485
485
 
486
486
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1442
487
487
 
@@ -516,7 +516,7 @@ If thisArg is omitted, undefined is used as the this value.
516
516
 
517
517
  ### fill()
518
518
 
519
- > **fill**(`value`, `start`?, `end`?): `this`
519
+ > **fill**(`value`, `start?`, `end?`): `this`
520
520
 
521
521
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:51
522
522
 
@@ -558,7 +558,7 @@ length+end.
558
558
 
559
559
  #### Call Signature
560
560
 
561
- > **filter**\<`S`\>(`predicate`, `thisArg`?): `S`[]
561
+ > **filter**\<`S`\>(`predicate`, `thisArg?`): `S`[]
562
562
 
563
563
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1469
564
564
 
@@ -594,7 +594,7 @@ An object to which the this keyword can refer in the predicate function. If this
594
594
 
595
595
  #### Call Signature
596
596
 
597
- > **filter**(`predicate`, `thisArg`?): `T`[]
597
+ > **filter**(`predicate`, `thisArg?`): `T`[]
598
598
 
599
599
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1475
600
600
 
@@ -628,7 +628,7 @@ An object to which the this keyword can refer in the predicate function. If this
628
628
 
629
629
  #### Call Signature
630
630
 
631
- > **find**\<`S`\>(`predicate`, `thisArg`?): `undefined` \| `S`
631
+ > **find**\<`S`\>(`predicate`, `thisArg?`): `S` \| `undefined`
632
632
 
633
633
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:29
634
634
 
@@ -660,7 +660,7 @@ predicate. If it is not provided, undefined is used instead.
660
660
 
661
661
  ##### Returns
662
662
 
663
- `undefined` \| `S`
663
+ `S` \| `undefined`
664
664
 
665
665
  ##### Inherited from
666
666
 
@@ -668,7 +668,7 @@ predicate. If it is not provided, undefined is used instead.
668
668
 
669
669
  #### Call Signature
670
670
 
671
- > **find**(`predicate`, `thisArg`?): `undefined` \| `T`
671
+ > **find**(`predicate`, `thisArg?`): `T` \| `undefined`
672
672
 
673
673
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:30
674
674
 
@@ -684,7 +684,7 @@ Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/li
684
684
 
685
685
  ##### Returns
686
686
 
687
- `undefined` \| `T`
687
+ `T` \| `undefined`
688
688
 
689
689
  ##### Inherited from
690
690
 
@@ -694,7 +694,7 @@ Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/li
694
694
 
695
695
  ### findIndex()
696
696
 
697
- > **findIndex**(`predicate`, `thisArg`?): `number`
697
+ > **findIndex**(`predicate`, `thisArg?`): `number`
698
698
 
699
699
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:41
700
700
 
@@ -730,7 +730,7 @@ predicate. If it is not provided, undefined is used instead.
730
730
 
731
731
  ### flat()
732
732
 
733
- > **flat**\<`A`, `D`\>(`this`, `depth`?): `FlatArray`\<`A`, `D`\>[]
733
+ > **flat**\<`A`, `D`\>(`this`, `depth?`): `FlatArray`\<`A`, `D`\>[]
734
734
 
735
735
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2019.array.d.ts:75
736
736
 
@@ -771,7 +771,7 @@ The maximum recursion depth
771
771
 
772
772
  ### flatMap()
773
773
 
774
- > **flatMap**\<`U`, `This`\>(`callback`, `thisArg`?): `U`[]
774
+ > **flatMap**\<`U`, `This`\>(`callback`, `thisArg?`): `U`[]
775
775
 
776
776
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2019.array.d.ts:64
777
777
 
@@ -817,7 +817,7 @@ thisArg is omitted, undefined is used as the this value.
817
817
 
818
818
  ### forEach()
819
819
 
820
- > **forEach**(`callbackfn`, `thisArg`?): `void`
820
+ > **forEach**(`callbackfn`, `thisArg?`): `void`
821
821
 
822
822
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1457
823
823
 
@@ -849,9 +849,9 @@ An object to which the this keyword can refer in the callbackfn function. If thi
849
849
 
850
850
  ### get()
851
851
 
852
- > **get**(`index`): `undefined` \| `T`
852
+ > **get**(`index`): `T` \| `undefined`
853
853
 
854
- Defined in: [src/deque.ts:176](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L176)
854
+ Defined in: [src/deque.ts:176](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L176)
855
855
 
856
856
  #### Parameters
857
857
 
@@ -861,13 +861,13 @@ Defined in: [src/deque.ts:176](https://github.com/isdk/util.js/blob/f6ac1e1b241d
861
861
 
862
862
  #### Returns
863
863
 
864
- `undefined` \| `T`
864
+ `T` \| `undefined`
865
865
 
866
866
  ***
867
867
 
868
868
  ### includes()
869
869
 
870
- > **includes**(`searchElement`, `fromIndex`?): `boolean`
870
+ > **includes**(`searchElement`, `fromIndex?`): `boolean`
871
871
 
872
872
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2016.array.include.d.ts:25
873
873
 
@@ -899,7 +899,7 @@ The position in this array at which to begin searching for searchElement.
899
899
 
900
900
  ### indexOf()
901
901
 
902
- > **indexOf**(`searchElement`, `fromIndex`?): `number`
902
+ > **indexOf**(`searchElement`, `fromIndex?`): `number`
903
903
 
904
904
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1418
905
905
 
@@ -933,7 +933,7 @@ The array index at which to begin the search. If fromIndex is omitted, the searc
933
933
 
934
934
  > **isEmpty**(): `boolean`
935
935
 
936
- Defined in: [src/deque.ts:217](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L217)
936
+ Defined in: [src/deque.ts:217](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L217)
937
937
 
938
938
  #### Returns
939
939
 
@@ -943,7 +943,7 @@ Defined in: [src/deque.ts:217](https://github.com/isdk/util.js/blob/f6ac1e1b241d
943
943
 
944
944
  ### join()
945
945
 
946
- > **join**(`separator`?): `string`
946
+ > **join**(`separator?`): `string`
947
947
 
948
948
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1361
949
949
 
@@ -987,7 +987,7 @@ Returns an iterable of keys in the array
987
987
 
988
988
  ### lastIndexOf()
989
989
 
990
- > **lastIndexOf**(`searchElement`, `fromIndex`?): `number`
990
+ > **lastIndexOf**(`searchElement`, `fromIndex?`): `number`
991
991
 
992
992
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1424
993
993
 
@@ -1019,7 +1019,7 @@ The array index at which to begin searching backward. If fromIndex is omitted, t
1019
1019
 
1020
1020
  ### map()
1021
1021
 
1022
- > **map**\<`U`\>(`callbackfn`, `thisArg`?): `U`[]
1022
+ > **map**\<`U`\>(`callbackfn`, `thisArg?`): `U`[]
1023
1023
 
1024
1024
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1463
1025
1025
 
@@ -1057,33 +1057,33 @@ An object to which the this keyword can refer in the callbackfn function. If thi
1057
1057
 
1058
1058
  ### peekBack()
1059
1059
 
1060
- > **peekBack**(): `undefined` \| `T`
1060
+ > **peekBack**(): `T` \| `undefined`
1061
1061
 
1062
- Defined in: [src/deque.ts:190](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L190)
1062
+ Defined in: [src/deque.ts:190](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L190)
1063
1063
 
1064
1064
  #### Returns
1065
1065
 
1066
- `undefined` \| `T`
1066
+ `T` \| `undefined`
1067
1067
 
1068
1068
  ***
1069
1069
 
1070
1070
  ### peekFront()
1071
1071
 
1072
- > **peekFront**(): `undefined` \| `T`
1072
+ > **peekFront**(): `T` \| `undefined`
1073
1073
 
1074
- Defined in: [src/deque.ts:199](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L199)
1074
+ Defined in: [src/deque.ts:199](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L199)
1075
1075
 
1076
1076
  #### Returns
1077
1077
 
1078
- `undefined` \| `T`
1078
+ `T` \| `undefined`
1079
1079
 
1080
1080
  ***
1081
1081
 
1082
1082
  ### pop()
1083
1083
 
1084
- > **pop**(`skipNull`?): `undefined` \| `T`
1084
+ > **pop**(`skipNull?`): `T` \| `undefined`
1085
1085
 
1086
- Defined in: [src/deque.ts:102](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L102)
1086
+ Defined in: [src/deque.ts:102](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L102)
1087
1087
 
1088
1088
  Removes and returns the element at the back of the deque.
1089
1089
 
@@ -1097,7 +1097,7 @@ When `true`, skips trailing `null`/`undefined` values until a valid element is f
1097
1097
 
1098
1098
  #### Returns
1099
1099
 
1100
- `undefined` \| `T`
1100
+ `T` \| `undefined`
1101
1101
 
1102
1102
  The removed element, or `undefined` if the deque is empty or all elements are skipped.
1103
1103
 
@@ -1133,7 +1133,7 @@ mixedDeque.pop(false); // null (explicitly not skipping)
1133
1133
 
1134
1134
  > **push**(`item`): `number`
1135
1135
 
1136
- Defined in: [src/deque.ts:52](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L52)
1136
+ Defined in: [src/deque.ts:52](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L52)
1137
1137
 
1138
1138
  Appends new elements to the end of an array, and returns the new length of the array.
1139
1139
 
@@ -1331,9 +1331,9 @@ If initialValue is specified, it is used as the initial value to start the accum
1331
1331
 
1332
1332
  ### removeAt()
1333
1333
 
1334
- > **removeAt**(`index`): `undefined` \| `T`
1334
+ > **removeAt**(`index`): `T` \| `undefined`
1335
1335
 
1336
- Defined in: [src/deque.ts:226](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L226)
1336
+ Defined in: [src/deque.ts:226](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L226)
1337
1337
 
1338
1338
  Removes the element at the specified index.
1339
1339
 
@@ -1347,7 +1347,7 @@ Logical index position (0 represents the front, length-1 represents the back)
1347
1347
 
1348
1348
  #### Returns
1349
1349
 
1350
- `undefined` \| `T`
1350
+ `T` \| `undefined`
1351
1351
 
1352
1352
  The removed element
1353
1353
 
@@ -1374,9 +1374,9 @@ This method mutates the array and returns a reference to the same array.
1374
1374
 
1375
1375
  ### shift()
1376
1376
 
1377
- > **shift**(`skipNull`?): `undefined` \| `T`
1377
+ > **shift**(`skipNull?`): `T` \| `undefined`
1378
1378
 
1379
- Defined in: [src/deque.ts:142](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L142)
1379
+ Defined in: [src/deque.ts:142](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L142)
1380
1380
 
1381
1381
  Removes and returns the element at the front of the deque.
1382
1382
 
@@ -1390,7 +1390,7 @@ When `true`, skips leading `null`/`undefined` values until a valid element is fo
1390
1390
 
1391
1391
  #### Returns
1392
1392
 
1393
- `undefined` \| `T`
1393
+ `T` \| `undefined`
1394
1394
 
1395
1395
  The removed element, or `undefined` if the deque is empty or all elements are skipped.
1396
1396
 
@@ -1424,7 +1424,7 @@ mixedDeque.shift(false); // null (explicitly not skipping)
1424
1424
 
1425
1425
  ### slice()
1426
1426
 
1427
- > **slice**(`start`?, `end`?): `T`[]
1427
+ > **slice**(`start?`, `end?`): `T`[]
1428
1428
 
1429
1429
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1381
1430
1430
 
@@ -1460,7 +1460,7 @@ If end is undefined, then the slice extends to the end of the array.
1460
1460
 
1461
1461
  ### some()
1462
1462
 
1463
- > **some**(`predicate`, `thisArg`?): `boolean`
1463
+ > **some**(`predicate`, `thisArg?`): `boolean`
1464
1464
 
1465
1465
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1451
1466
1466
 
@@ -1495,7 +1495,7 @@ If thisArg is omitted, undefined is used as the this value.
1495
1495
 
1496
1496
  ### sort()
1497
1497
 
1498
- > **sort**(`compareFn`?): `this`
1498
+ > **sort**(`compareFn?`): `this`
1499
1499
 
1500
1500
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1392
1501
1501
 
@@ -1529,7 +1529,7 @@ value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code u
1529
1529
 
1530
1530
  #### Call Signature
1531
1531
 
1532
- > **splice**(`start`, `deleteCount`?): `T`[]
1532
+ > **splice**(`start`, `deleteCount?`): `T`[]
1533
1533
 
1534
1534
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1399
1535
1535
 
@@ -1619,7 +1619,7 @@ Returns a string representation of an array. The elements are converted to strin
1619
1619
 
1620
1620
  #### Call Signature
1621
1621
 
1622
- > **toLocaleString**(`locales`, `options`?): `string`
1622
+ > **toLocaleString**(`locales`, `options?`): `string`
1623
1623
 
1624
1624
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:64
1625
1625
 
@@ -1665,7 +1665,7 @@ Returns a string representation of an array.
1665
1665
 
1666
1666
  > **unshift**(`item`): `number`
1667
1667
 
1668
- Defined in: [src/deque.ts:65](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/deque.ts#L65)
1668
+ Defined in: [src/deque.ts:65](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/deque.ts#L65)
1669
1669
 
1670
1670
  Inserts new elements at the start of an array, and returns the new length of the array.
1671
1671
 
@@ -1737,7 +1737,7 @@ An array-like object to convert to an array.
1737
1737
 
1738
1738
  #### Call Signature
1739
1739
 
1740
- > `static` **from**\<`T`, `U`\>(`arrayLike`, `mapfn`, `thisArg`?): `U`[]
1740
+ > `static` **from**\<`T`, `U`\>(`arrayLike`, `mapfn`, `thisArg?`): `U`[]
1741
1741
 
1742
1742
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.core.d.ts:80
1743
1743
 
@@ -1813,7 +1813,7 @@ An iterable object to convert to an array.
1813
1813
 
1814
1814
  #### Call Signature
1815
1815
 
1816
- > `static` **from**\<`T`, `U`\>(`iterable`, `mapfn`, `thisArg`?): `U`[]
1816
+ > `static` **from**\<`T`, `U`\>(`iterable`, `mapfn`, `thisArg?`): `U`[]
1817
1817
 
1818
1818
  Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2015.iterable.d.ts:109
1819
1819
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: IntSet
8
8
 
9
- Defined in: [src/intset.ts:6](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L6)
9
+ Defined in: [src/intset.ts:6](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L6)
10
10
 
11
11
  Represents a set of integers using a bit field.
12
12
  Each bit in the bit field represents an integer starting from 0,
@@ -18,7 +18,7 @@ where the flag value 0 represents the 0th bit, 1 represents the 1st bit, and so
18
18
 
19
19
  > **new IntSet**(`bitField`): `IntSet`
20
20
 
21
- Defined in: [src/intset.ts:21](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L21)
21
+ Defined in: [src/intset.ts:21](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L21)
22
22
 
23
23
  #### Parameters
24
24
 
@@ -36,7 +36,7 @@ Defined in: [src/intset.ts:21](https://github.com/isdk/util.js/blob/f6ac1e1b241d
36
36
 
37
37
  > **add**(`flag`): `IntSet`
38
38
 
39
- Defined in: [src/intset.ts:29](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L29)
39
+ Defined in: [src/intset.ts:29](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L29)
40
40
 
41
41
  Adds an element to the set.
42
42
 
@@ -59,7 +59,7 @@ The flag value representing the bit position to set.
59
59
 
60
60
  > **clear**(): `IntSet`
61
61
 
62
- Defined in: [src/intset.ts:57](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L57)
62
+ Defined in: [src/intset.ts:57](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L57)
63
63
 
64
64
  Clears all elements from the set.
65
65
 
@@ -73,7 +73,7 @@ Clears all elements from the set.
73
73
 
74
74
  > **delete**(`flag`): `IntSet`
75
75
 
76
- Defined in: [src/intset.ts:39](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L39)
76
+ Defined in: [src/intset.ts:39](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L39)
77
77
 
78
78
  Removes an element from the set.
79
79
 
@@ -95,7 +95,7 @@ The flag value representing the bit position to set. 0 represents the 0th bit
95
95
 
96
96
  > **has**(`flag`): `boolean`
97
97
 
98
- Defined in: [src/intset.ts:50](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L50)
98
+ Defined in: [src/intset.ts:50](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L50)
99
99
 
100
100
  Determines whether an element is in the set.
101
101
 
@@ -119,7 +119,7 @@ true if the element is in the set; otherwise, false.
119
119
 
120
120
  > **toJSON**(): `number`
121
121
 
122
- Defined in: [src/intset.ts:70](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L70)
122
+ Defined in: [src/intset.ts:70](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L70)
123
123
 
124
124
  #### Returns
125
125
 
@@ -131,7 +131,7 @@ Defined in: [src/intset.ts:70](https://github.com/isdk/util.js/blob/f6ac1e1b241d
131
131
 
132
132
  > **toString**(): `string`
133
133
 
134
- Defined in: [src/intset.ts:66](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L66)
134
+ Defined in: [src/intset.ts:66](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L66)
135
135
 
136
136
  #### Returns
137
137
 
@@ -143,7 +143,7 @@ Defined in: [src/intset.ts:66](https://github.com/isdk/util.js/blob/f6ac1e1b241d
143
143
 
144
144
  > **valueOf**(): `number`
145
145
 
146
- Defined in: [src/intset.ts:62](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L62)
146
+ Defined in: [src/intset.ts:62](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L62)
147
147
 
148
148
  #### Returns
149
149
 
@@ -155,7 +155,7 @@ Defined in: [src/intset.ts:62](https://github.com/isdk/util.js/blob/f6ac1e1b241d
155
155
 
156
156
  > `static` **add**(`bitField`, `flag`): `number`
157
157
 
158
- Defined in: [src/intset.ts:12](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L12)
158
+ Defined in: [src/intset.ts:12](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L12)
159
159
 
160
160
  #### Parameters
161
161
 
@@ -177,7 +177,7 @@ Defined in: [src/intset.ts:12](https://github.com/isdk/util.js/blob/f6ac1e1b241d
177
177
 
178
178
  > `static` **delete**(`bitField`, `flag`): `number`
179
179
 
180
- Defined in: [src/intset.ts:16](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L16)
180
+ Defined in: [src/intset.ts:16](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L16)
181
181
 
182
182
  #### Parameters
183
183
 
@@ -199,7 +199,7 @@ Defined in: [src/intset.ts:16](https://github.com/isdk/util.js/blob/f6ac1e1b241d
199
199
 
200
200
  > `static` **has**(`bitField`, `flag`): `boolean`
201
201
 
202
- Defined in: [src/intset.ts:8](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/intset.ts#L8)
202
+ Defined in: [src/intset.ts:8](https://github.com/isdk/util.js/blob/40caefda2d376f288af37d8babc9da0357d94056/src/intset.ts#L8)
203
203
 
204
204
  #### Parameters
205
205