@isdk/util 0.3.2 → 0.3.4

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 (55) hide show
  1. package/dist/index.d.mts +464 -1
  2. package/dist/index.d.ts +464 -1
  3. package/dist/index.js +1 -1
  4. package/dist/index.mjs +1 -1
  5. package/docs/classes/BinarySemaphore.md +418 -0
  6. package/docs/classes/ConfigFile.md +9 -9
  7. package/docs/classes/Deque.md +1912 -0
  8. package/docs/classes/IntSet.md +216 -0
  9. package/docs/classes/Semaphore.md +538 -0
  10. package/docs/classes/SignalGate.md +184 -0
  11. package/docs/functions/RateLimit.md +37 -0
  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 +25 -0
  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/parseFrontMatter.md +1 -1
  23. package/docs/functions/parseYaml.md +2 -2
  24. package/docs/functions/reControlCharsRegex.md +1 -1
  25. package/docs/functions/registerYamlTag.md +2 -2
  26. package/docs/functions/removeLeadingEmptyLines.md +1 -1
  27. package/docs/functions/sanitizeFilename.md +1 -1
  28. package/docs/functions/sanitizeFilepath.md +1 -1
  29. package/docs/functions/sleep.md +36 -0
  30. package/docs/functions/stringifyYaml.md +2 -2
  31. package/docs/functions/toCamelCase.md +1 -1
  32. package/docs/functions/toCapitalCase.md +1 -1
  33. package/docs/functions/toPascalCase.md +1 -1
  34. package/docs/functions/traverseFolder.md +1 -1
  35. package/docs/functions/traverseFolderSync.md +1 -1
  36. package/docs/functions/yieldExec.md +27 -0
  37. package/docs/globals.md +17 -0
  38. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
  39. package/docs/interfaces/BinarySemaphoreOptions.md +57 -0
  40. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
  41. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
  42. package/docs/interfaces/IncludeFiles.md +3 -3
  43. package/docs/interfaces/LoadConfigFileOptions.md +3 -3
  44. package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
  45. package/docs/interfaces/SemaphoreOptions.md +89 -0
  46. package/docs/interfaces/SemaphoreTaskItem.md +73 -0
  47. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +15 -0
  48. package/docs/type-aliases/StringifyFunc.md +1 -1
  49. package/docs/type-aliases/TraverseFolderHandler.md +1 -1
  50. package/docs/type-aliases/TraverseFolderSyncHandler.md +1 -1
  51. package/docs/variables/DefaultAllTextFiles.md +1 -1
  52. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +11 -0
  53. package/docs/variables/FilenameReservedRegex.md +1 -1
  54. package/docs/variables/WindowsReservedNameRegex.md +1 -1
  55. package/package.json +19 -17
package/docs/classes/IntSet.md ADDED
@@ -0,0 +1,216 @@
1
+ [**@isdk/util**](../README.md)
2
+
3
+ ***
4
+
5
+ [@isdk/util](../globals.md) / IntSet
6
+
7
+ # Class: IntSet
8
+
9
+ Defined in: [src/intset.ts:6](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L6)
10
+
11
+ Represents a set of integers using a bit field.
12
+ Each bit in the bit field represents an integer starting from 0,
13
+ where the flag value 0 represents the 0th bit, 1 represents the 1st bit, and so on.
14
+
15
+ ## Constructors
16
+
17
+ ### Constructor
18
+
19
+ > **new IntSet**(`bitField`): `IntSet`
20
+
21
+ Defined in: [src/intset.ts:21](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L21)
22
+
23
+ #### Parameters
24
+
25
+ ##### bitField
26
+
27
+ `number` = `0`
28
+
29
+ #### Returns
30
+
31
+ `IntSet`
32
+
33
+ ## Methods
34
+
35
+ ### add()
36
+
37
+ > **add**(`flag`): `IntSet`
38
+
39
+ Defined in: [src/intset.ts:29](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L29)
40
+
41
+ Adds an element to the set.
42
+
43
+ #### Parameters
44
+
45
+ ##### flag
46
+
47
+ `number`
48
+
49
+ The flag value representing the bit position to set.
50
+ Note: the flag value 0 represents the 0th bit, and so on.
51
+
52
+ #### Returns
53
+
54
+ `IntSet`
55
+
56
+ ***
57
+
58
+ ### clear()
59
+
60
+ > **clear**(): `IntSet`
61
+
62
+ Defined in: [src/intset.ts:57](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L57)
63
+
64
+ Clears all elements from the set.
65
+
66
+ #### Returns
67
+
68
+ `IntSet`
69
+
70
+ ***
71
+
72
+ ### delete()
73
+
74
+ > **delete**(`flag`): `IntSet`
75
+
76
+ Defined in: [src/intset.ts:39](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L39)
77
+
78
+ Removes an element from the set.
79
+
80
+ #### Parameters
81
+
82
+ ##### flag
83
+
84
+ `number`
85
+
86
+ The flag value representing the bit position to set. 0 represents the 0th bit
87
+
88
+ #### Returns
89
+
90
+ `IntSet`
91
+
92
+ ***
93
+
94
+ ### has()
95
+
96
+ > **has**(`flag`): `boolean`
97
+
98
+ Defined in: [src/intset.ts:50](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L50)
99
+
100
+ Determines whether an element is in the set.
101
+
102
+ #### Parameters
103
+
104
+ ##### flag
105
+
106
+ `number`
107
+
108
+ The flag value representing the bit position to set. 0 represents the 0th bit
109
+
110
+ #### Returns
111
+
112
+ `boolean`
113
+
114
+ true if the element is in the set; otherwise, false.
115
+
116
+ ***
117
+
118
+ ### toJSON()
119
+
120
+ > **toJSON**(): `number`
121
+
122
+ Defined in: [src/intset.ts:70](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L70)
123
+
124
+ #### Returns
125
+
126
+ `number`
127
+
128
+ ***
129
+
130
+ ### toString()
131
+
132
+ > **toString**(): `string`
133
+
134
+ Defined in: [src/intset.ts:66](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L66)
135
+
136
+ #### Returns
137
+
138
+ `string`
139
+
140
+ ***
141
+
142
+ ### valueOf()
143
+
144
+ > **valueOf**(): `number`
145
+
146
+ Defined in: [src/intset.ts:62](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L62)
147
+
148
+ #### Returns
149
+
150
+ `number`
151
+
152
+ ***
153
+
154
+ ### add()
155
+
156
+ > `static` **add**(`bitField`, `flag`): `number`
157
+
158
+ Defined in: [src/intset.ts:12](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L12)
159
+
160
+ #### Parameters
161
+
162
+ ##### bitField
163
+
164
+ `number`
165
+
166
+ ##### flag
167
+
168
+ `number`
169
+
170
+ #### Returns
171
+
172
+ `number`
173
+
174
+ ***
175
+
176
+ ### delete()
177
+
178
+ > `static` **delete**(`bitField`, `flag`): `number`
179
+
180
+ Defined in: [src/intset.ts:16](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L16)
181
+
182
+ #### Parameters
183
+
184
+ ##### bitField
185
+
186
+ `number`
187
+
188
+ ##### flag
189
+
190
+ `number`
191
+
192
+ #### Returns
193
+
194
+ `number`
195
+
196
+ ***
197
+
198
+ ### has()
199
+
200
+ > `static` **has**(`bitField`, `flag`): `boolean`
201
+
202
+ Defined in: [src/intset.ts:8](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/intset.ts#L8)
203
+
204
+ #### Parameters
205
+
206
+ ##### bitField
207
+
208
+ `number`
209
+
210
+ ##### flag
211
+
212
+ `number`
213
+
214
+ #### Returns
215
+
216
+ `boolean`