@isdk/util 0.3.3 → 0.3.4

package/docs/classes/Semaphore.md

@@ -6,7 +6,7 @@
 
 # Class: Semaphore
 
-Defined in: [src/async-semaphore.ts:372](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L372)
+Defined in: [src/async-semaphore.ts:372](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L372)
 
 A Semaphore implementation for managing concurrency in asynchronous operations.
 Semaphores allow a fixed number of resources to be accessed concurrently.
@@ -55,9 +55,9 @@ const data = await Promise.all(array.map(fetchData));
 
 ### Constructor
 
-> **new Semaphore**(`maxConcurrency`, `options`?): `Semaphore`
+> **new Semaphore**(`maxConcurrency`, `options?`): `Semaphore`
 
-Defined in: [src/async-semaphore.ts:390](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L390)
+Defined in: [src/async-semaphore.ts:390](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L390)
 
 Creates a semaphore object. The first argument is the maximum concurrently number and the second argument is optional.
 
@@ -87,7 +87,7 @@ The maximum number of callers allowed to acquire the semaphore concurrently.
 
 > `protected` **\_activeCount**: `number`
 
-Defined in: [src/async-semaphore.ts:97](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L97)
+Defined in: [src/async-semaphore.ts:97](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L97)
 
 #### Inherited from
 
@@ -99,7 +99,7 @@ Defined in: [src/async-semaphore.ts:97](https://github.com/isdk/util.js/blob/f6a
 
 > `protected` **emitter**: `EventEmitter`
 
-Defined in: [src/async-semaphore.ts:91](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L91)
+Defined in: [src/async-semaphore.ts:91](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L91)
 
 #### Inherited from
 
@@ -111,7 +111,7 @@ Defined in: [src/async-semaphore.ts:91](https://github.com/isdk/util.js/blob/f6a
 
 > `protected` **free**: [`Deque`](Deque.md)\<`any`\>
 
-Defined in: [src/async-semaphore.ts:374](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L374)
+Defined in: [src/async-semaphore.ts:374](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L374)
 
 #### Overrides
 
@@ -121,9 +121,9 @@ Defined in: [src/async-semaphore.ts:374](https://github.com/isdk/util.js/blob/f6
 
 ### initTokenFn()
 
-> `protected` **initTokenFn**: (`token`?) => `void`
+> `protected` **initTokenFn**: (`token?`) => `void`
 
-Defined in: [src/async-semaphore.ts:95](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L95)
+Defined in: [src/async-semaphore.ts:95](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L95)
 
 #### Parameters
 
@@ -145,7 +145,7 @@ Defined in: [src/async-semaphore.ts:95](https://github.com/isdk/util.js/blob/f6a
 
 > `readonly` **maxConcurrency**: `number`
 
-Defined in: [src/async-semaphore.ts:373](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L373)
+Defined in: [src/async-semaphore.ts:373](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L373)
 
 ***
 
@@ -153,7 +153,7 @@ Defined in: [src/async-semaphore.ts:373](https://github.com/isdk/util.js/blob/f6
 
 > `protected` **paused**: `boolean`
 
-Defined in: [src/async-semaphore.ts:96](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L96)
+Defined in: [src/async-semaphore.ts:96](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L96)
 
 #### Inherited from
 
@@ -165,7 +165,7 @@ Defined in: [src/async-semaphore.ts:96](https://github.com/isdk/util.js/blob/f6a
 
 > `protected` `optional` **pauseFn**: () => `void`
 
-Defined in: [src/async-semaphore.ts:93](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L93)
+Defined in: [src/async-semaphore.ts:93](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L93)
 
 #### Returns
 
@@ -181,7 +181,7 @@ Defined in: [src/async-semaphore.ts:93](https://github.com/isdk/util.js/blob/f6a
 
 > `protected` `optional` **resumeFn**: () => `void`
 
-Defined in: [src/async-semaphore.ts:94](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L94)
+Defined in: [src/async-semaphore.ts:94](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L94)
 
 #### Returns
 
@@ -197,7 +197,7 @@ Defined in: [src/async-semaphore.ts:94](https://github.com/isdk/util.js/blob/f6a
 
 > `protected` **useDefaultTokens**: `boolean`
 
-Defined in: [src/async-semaphore.ts:92](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L92)
+Defined in: [src/async-semaphore.ts:92](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L92)
 
 #### Inherited from
 
@@ -207,9 +207,9 @@ Defined in: [src/async-semaphore.ts:92](https://github.com/isdk/util.js/blob/f6a
 
 ### waiting
 
-> `readonly` **waiting**: [`Deque`](Deque.md)\<`undefined` \| [`SemaphoreTaskItem`](../interfaces/SemaphoreTaskItem.md)\>
+> `readonly` **waiting**: [`Deque`](Deque.md)\<[`SemaphoreTaskItem`](../interfaces/SemaphoreTaskItem.md) \| `undefined`\>
 
-Defined in: [src/async-semaphore.ts:89](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L89)
+Defined in: [src/async-semaphore.ts:89](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L89)
 
 #### Inherited from
 
@@ -223,7 +223,7 @@ Defined in: [src/async-semaphore.ts:89](https://github.com/isdk/util.js/blob/f6a
 
 > **get** **activeCount**(): `number`
 
-Defined in: [src/async-semaphore.ts:318](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L318)
+Defined in: [src/async-semaphore.ts:318](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L318)
 
 Get the total count of all active operations.
 
@@ -249,7 +249,7 @@ The total count of active operations, including both waiting and ongoing tasks.
 
 > **get** **pendingCount**(): `number`
 
-Defined in: [src/async-semaphore.ts:327](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L327)
+Defined in: [src/async-semaphore.ts:327](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L327)
 
 Get the number of callers waiting on the semaphore, i.e. the number of pending promises.
 
@@ -267,9 +267,9 @@ The number of waiters in the waiting list.
 
 ### \_dispatchTask()
 
-> **\_dispatchTask**(`task`, `options`?): `void`
+> **\_dispatchTask**(`task`, `options?`): `void`
 
-Defined in: [src/async-semaphore.ts:212](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L212)
+Defined in: [src/async-semaphore.ts:212](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L212)
 
 #### Parameters
 
@@ -293,9 +293,9 @@ Defined in: [src/async-semaphore.ts:212](https://github.com/isdk/util.js/blob/f6
 
 ### \_newReleaser()
 
-> **\_newReleaser**(`options`?): [`BinarySemaphoreReleaserFunc`](../interfaces/BinarySemaphoreReleaserFunc.md)
+> **\_newReleaser**(`options?`): [`BinarySemaphoreReleaserFunc`](../interfaces/BinarySemaphoreReleaserFunc.md)
 
-Defined in: [src/async-semaphore.ts:199](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L199)
+Defined in: [src/async-semaphore.ts:199](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L199)
 
 #### Parameters
 
@@ -315,9 +315,9 @@ Defined in: [src/async-semaphore.ts:199](https://github.com/isdk/util.js/blob/f6
 
 ### abort()
 
-> **abort**(`reason`?): `void`
+> **abort**(`reason?`): `void`
 
-Defined in: [src/async-semaphore.ts:301](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L301)
+Defined in: [src/async-semaphore.ts:301](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L301)
 
 #### Parameters
 
@@ -337,9 +337,9 @@ Defined in: [src/async-semaphore.ts:301](https://github.com/isdk/util.js/blob/f6
 
 ### acquire()
 
-> **acquire**(`options`?): `Promise`\<[`BinarySemaphoreReleaserFunc`](../interfaces/BinarySemaphoreReleaserFunc.md)\>
+> **acquire**(`options?`): `Promise`\<[`BinarySemaphoreReleaserFunc`](../interfaces/BinarySemaphoreReleaserFunc.md)\>
 
-Defined in: [src/async-semaphore.ts:243](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L243)
+Defined in: [src/async-semaphore.ts:243](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L243)
 
 Acquire a token from the semaphore, thus decrement the number of available execution slots. If initFn is not used then the return value of the function can be discarded.
 
@@ -365,7 +365,7 @@ A promise that resolves to a release function when a token is acquired. If the s
 
 > **drain**(): `Promise`\<`any`[]\>
 
-Defined in: [src/async-semaphore.ts:439](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L439)
+Defined in: [src/async-semaphore.ts:439](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L439)
 
 Drains the semaphore and returns all the initialized tokens in an array. Draining is an ideal way to ensure there are no pending async tasks, for example before a process will terminate.
 
@@ -383,7 +383,7 @@ Drains the semaphore and returns all the initialized tokens in an array. Drainin
 
 > **init**(`options`): `void`
 
-Defined in: [src/async-semaphore.ts:193](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L193)
+Defined in: [src/async-semaphore.ts:193](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L193)
 
 #### Parameters
 
@@ -405,7 +405,7 @@ Defined in: [src/async-semaphore.ts:193](https://github.com/isdk/util.js/blob/f6
 
 > **initFree**(`options`): `void`
 
-Defined in: [src/async-semaphore.ts:408](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L408)
+Defined in: [src/async-semaphore.ts:408](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L408)
 
 #### Parameters
 
@@ -425,9 +425,9 @@ Defined in: [src/async-semaphore.ts:408](https://github.com/isdk/util.js/blob/f6
 
 ### lock()
 
-> **lock**(`options`?): `any`
+> **lock**(`options?`): `any`
 
-Defined in: [src/async-semaphore.ts:435](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L435)
+Defined in: [src/async-semaphore.ts:435](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L435)
 
 #### Parameters
 
@@ -447,9 +447,9 @@ Defined in: [src/async-semaphore.ts:435](https://github.com/isdk/util.js/blob/f6
 
 ### onReleased()
 
-> **onReleased**(`options`?): `void`
+> **onReleased**(`options?`): `void`
 
-Defined in: [src/async-semaphore.ts:177](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L177)
+Defined in: [src/async-semaphore.ts:177](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L177)
 
 #### Parameters
 
@@ -469,9 +469,9 @@ Defined in: [src/async-semaphore.ts:177](https://github.com/isdk/util.js/blob/f6
 
 ### release()
 
-> **release**(`options`?): `void`
+> **release**(`options?`): `void`
 
-Defined in: [src/async-semaphore.ts:288](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L288)
+Defined in: [src/async-semaphore.ts:288](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L288)
 
 Releases the semaphore, incrementing the number of free execution slots. If there are tasks in the waiting queue, the next task will be dispatched.
 
@@ -493,9 +493,9 @@ Releases the semaphore, incrementing the number of free execution slots. If ther
 
 ### tryAcquire()
 
-> **tryAcquire**(`options`?): `any`
+> **tryAcquire**(`options?`): `any`
 
-Defined in: [src/async-semaphore.ts:416](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L416)
+Defined in: [src/async-semaphore.ts:416](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L416)
 
 Attempt to acquire a token from the semaphore, if one is available immediately. Otherwise, return undefined.
 
@@ -519,9 +519,9 @@ Returns a token if the semaphore is not full; otherwise, returns `undefined`.
 
 ### unlock()
 
-> **unlock**(`token`?): `void`
+> **unlock**(`token?`): `void`
 
-Defined in: [src/async-semaphore.ts:431](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L431)
+Defined in: [src/async-semaphore.ts:431](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L431)
 
 #### Parameters
 

package/docs/classes/SignalGate.md

@@ -6,7 +6,7 @@
 
 # Class: SignalGate\<T\>
 
-Defined in: [src/async-signal-gate.ts:20](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L20)
+Defined in: [src/async-signal-gate.ts:20](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L20)
 
 An asynchronous signal gate that blocks operations until a signal is emitted.
 This class allows multiple awaiters to wait for a signal and resolves all pending promises with the emitted value.
@@ -46,15 +46,15 @@ valueGate.signal(42); // Must provide a number value
 
 > `protected` **\_isSignaled**: `boolean` = `false`
 
-Defined in: [src/async-signal-gate.ts:21](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L21)
+Defined in: [src/async-signal-gate.ts:21](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L21)
 
 ***
 
 ### \_signalValue
 
-> `protected` **\_signalValue**: `undefined` \| `T`
+> `protected` **\_signalValue**: `T` \| `undefined`
 
-Defined in: [src/async-signal-gate.ts:22](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L22)
+Defined in: [src/async-signal-gate.ts:22](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L22)
 
 ***
 
@@ -62,7 +62,7 @@ Defined in: [src/async-signal-gate.ts:22](https://github.com/isdk/util.js/blob/f
 
 > `protected` **waitQueue**: `object`[] = `[]`
 
-Defined in: [src/async-signal-gate.ts:23](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L23)
+Defined in: [src/async-signal-gate.ts:23](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L23)
 
 #### reject()
 
@@ -100,7 +100,7 @@ Defined in: [src/async-signal-gate.ts:23](https://github.com/isdk/util.js/blob/f
 
 > **get** **signaled**(): `boolean`
 
-Defined in: [src/async-signal-gate.ts:28](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L28)
+Defined in: [src/async-signal-gate.ts:28](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L28)
 
 ##### Returns
 
@@ -110,9 +110,9 @@ Defined in: [src/async-signal-gate.ts:28](https://github.com/isdk/util.js/blob/f
 
 ### abort()
 
-> **abort**(`reason`?): `void`
+> **abort**(`reason?`): `void`
 
-Defined in: [src/async-signal-gate.ts:65](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L65)
+Defined in: [src/async-signal-gate.ts:65](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L65)
 
 Aborts all pending waits, rejecting their promises with an error.
 This does **not** reset the signal state (the gate remains signaled or unsignaled).
@@ -135,7 +135,7 @@ The reason for aborting the waits.
 
 > **reset**(): `void`
 
-Defined in: [src/async-signal-gate.ts:53](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L53)
+Defined in: [src/async-signal-gate.ts:53](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L53)
 
 Resets the gate to its initial state, allowing a new signal to be emitted.
 
@@ -147,9 +147,9 @@ Resets the gate to its initial state, allowing a new signal to be emitted.
 
 ### signal()
 
-> **signal**(`value`?): `void`
+> **signal**(`value?`): `void`
 
-Defined in: [src/async-signal-gate.ts:38](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L38)
+Defined in: [src/async-signal-gate.ts:38](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L38)
 
 Emits the signal with an optional value, resolving all pending [wait](#wait) promises.
 Subsequent calls have no effect until [reset](#reset) is called.
@@ -172,7 +172,7 @@ The value to emit with the signal (only required if T is not void).
 
 > **wait**(): `Promise`\<`T`\>
 
-Defined in: [src/async-signal-gate.ts:83](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-signal-gate.ts#L83)
+Defined in: [src/async-signal-gate.ts:83](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-signal-gate.ts#L83)
 
 Returns a promise that resolves with the emitted signal value.
 If called after the signal has been emitted, resolves immediately with the stored value.

package/docs/functions/RateLimit.md

@@ -8,7 +8,7 @@
 
 > **RateLimit**(`rps`, `__namedParameters`): () => `Promise`\<`void`\>
 
-Defined in: [src/async-semaphore.ts:476](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/async-semaphore.ts#L476)
+Defined in: [src/async-semaphore.ts:476](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/async-semaphore.ts#L476)
 
 Creates a rate limiter function that blocks with a promise whenever the rate limit is hit and resolves the promise once the call rate is within the limit set by rps. The second argument is optional.
 
@@ -30,7 +30,7 @@ Creates a rate limiter function that blocks with a promise whenever the rate lim
 
 ## Returns
 
-`Function`
+> (): `Promise`\<`void`\>
 
 ### Returns
 

package/docs/functions/arrayHasAll.md

@@ -8,7 +8,7 @@
 
 > **arrayHasAll**\<`T`\>(`array`, `elements`): `boolean`
 
-Defined in: [src/array-has-all.ts:15](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/array-has-all.ts#L15)
+Defined in: [src/array-has-all.ts:15](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/array-has-all.ts#L15)
 
 Checks whether the provided array contains all of the specified elements.
 

package/docs/functions/extNameLevel.md

@@ -8,7 +8,7 @@
 
 > **extNameLevel**(`extName`): `number`
 
-Defined in: [src/filename.ts:189](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L189)
+Defined in: [src/filename.ts:189](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L189)
 
 Calculates the level of an extension name.
 

package/docs/functions/filenameReservedRegex.md

@@ -8,7 +8,7 @@
 
 > **filenameReservedRegex**(): `RegExp`
 
-Defined in: [src/filename.ts:42](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L42)
+Defined in: [src/filename.ts:42](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L42)
 
 Returns a new regular expression instance for reserved filename characters with the 'g' flag.
 use this to reset the with global option

package/docs/functions/findPort.md

@@ -8,7 +8,7 @@
 
 > **findPort**(`port`, `portRetryCount`): `Promise`\<`number`\>
 
-Defined in: [src/find-port.ts:3](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/find-port.ts#L3)
+Defined in: [src/find-port.ts:3](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/find-port.ts#L3)
 
 ## Parameters
 

package/docs/functions/getMultiLevelExtname.md

@@ -8,7 +8,7 @@
 
 > **getMultiLevelExtname**(`filename`, `level`): `string`
 
-Defined in: [src/get-multi-level-extname.ts:9](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/get-multi-level-extname.ts#L9)
+Defined in: [src/get-multi-level-extname.ts:9](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/get-multi-level-extname.ts#L9)
 
 Retrieves multi-level file extension
 

package/docs/functions/glob.md

@@ -6,9 +6,9 @@
 
 # Function: glob()
 
-> **glob**(`filepath`, `pattern`, `rootDir`?): `undefined` \| `boolean`
+> **glob**(`filepath`, `pattern`, `rootDir?`): `boolean` \| `undefined`
 
-Defined in: [src/glob.ts:29](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/glob.ts#L29)
+Defined in: [src/glob.ts:29](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/glob.ts#L29)
 
 Matches a file path against a list of glob patterns.
 
@@ -38,7 +38,7 @@ An array of glob patterns to match against.
 
 ## Returns
 
-`undefined` \| `boolean`
+`boolean` \| `undefined`
 
 Returns `true` if the `filepath` matches any of the patterns, otherwise `false`.
 

package/docs/functions/isStringIn.md

@@ -8,7 +8,7 @@
 
 > **isStringIn**(`str`, `arr`): `boolean`
 
-Defined in: [src/is-string-in.ts:17](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/is-string-in.ts#L17)
+Defined in: [src/is-string-in.ts:17](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/is-string-in.ts#L17)
 
 Checks if a given string exists within an array of strings or a single string.
 

package/docs/functions/isValidFilename.md

@@ -8,7 +8,7 @@
 
 > **isValidFilename**(`filename`): `boolean` \| `""`
 
-Defined in: [src/filename.ts:63](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L63)
+Defined in: [src/filename.ts:63](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L63)
 
 Validates if a given string is a valid filename.
 

package/docs/functions/isValidFilepath.md

@@ -8,7 +8,7 @@
 
 > **isValidFilepath**(`filepath`): `boolean`
 
-Defined in: [src/filename.ts:72](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L72)
+Defined in: [src/filename.ts:72](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L72)
 
 Validates whether the given filepath is valid.
 

package/docs/functions/normalizeIncludeFiles.md

@@ -6,9 +6,9 @@
 
 # Function: normalizeIncludeFiles()
 
-> **normalizeIncludeFiles**(`files`?, `defaultFiles`?): `string`[]
+> **normalizeIncludeFiles**(`files?`, `defaultFiles?`): `string`[]
 
-Defined in: [src/include-files.ts:34](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/include-files.ts#L34)
+Defined in: [src/include-files.ts:34](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/include-files.ts#L34)
 
 Normalizes a list of file patterns for glob matching.
 

package/docs/functions/parseFrontMatter.md

@@ -8,7 +8,7 @@
 
 > **parseFrontMatter**(`value`, `delimiter`): `object`
 
-Defined in: [src/front-matter.ts:6](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/front-matter.ts#L6)
+Defined in: [src/front-matter.ts:6](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/front-matter.ts#L6)
 
 ## Parameters
 

package/docs/functions/parseYaml.md

@@ -6,9 +6,9 @@
 
 # Function: parseYaml()
 
-> **parseYaml**(`content`, `options`?): `any`
+> **parseYaml**(`content`, `options?`): `any`
 
-Defined in: [src/yaml.ts:51](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/yaml.ts#L51)
+Defined in: [src/yaml.ts:51](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/yaml.ts#L51)
 
 Parses a YAML string into a JavaScript object with optional custom tags.
 

package/docs/functions/reControlCharsRegex.md

@@ -8,7 +8,7 @@
 
 > **reControlCharsRegex**(): `RegExp`
 
-Defined in: [src/filename.ts:50](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L50)
+Defined in: [src/filename.ts:50](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L50)
 
 Returns a new regular expression instance for control characters in a filename with the 'g' flag.
 

package/docs/functions/registerYamlTag.md

@@ -8,7 +8,7 @@
 
 > **registerYamlTag**(`tags`): `void`
 
-Defined in: [src/yaml.ts:23](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/yaml.ts#L23)
+Defined in: [src/yaml.ts:23](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/yaml.ts#L23)
 
 Registers custom YAML tags to be used in parsing and stringifying YAML content.
 

package/docs/functions/removeLeadingEmptyLines.md

@@ -8,7 +8,7 @@
 
 > **removeLeadingEmptyLines**(`text`): `string`
 
-Defined in: [src/remove-leading-empty-lines.ts:16](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/remove-leading-empty-lines.ts#L16)
+Defined in: [src/remove-leading-empty-lines.ts:16](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/remove-leading-empty-lines.ts#L16)
 
 Removes all leading empty lines or "#" comments line from the given string.
 

package/docs/functions/sanitizeFilename.md

@@ -8,7 +8,7 @@
 
 > **sanitizeFilename**(`filename`, `options`): `string`
 
-Defined in: [src/filename.ts:97](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L97)
+Defined in: [src/filename.ts:97](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L97)
 
 Sanitizes a given filename by replacing invalid characters with a specified replacement character or a default.
 

package/docs/functions/sanitizeFilepath.md

@@ -8,7 +8,7 @@
 
 > **sanitizeFilepath**(`filepath`, `options`): `string`
 
-Defined in: [src/filename.ts:149](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/filename.ts#L149)
+Defined in: [src/filename.ts:149](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/filename.ts#L149)
 
 Sanitizes each part of a file path and reassembles it, ensuring the path is valid according to provided options.
 

package/docs/functions/sleep.md

@@ -8,7 +8,7 @@
 
 > **sleep**(`ms`): `Promise`\<`void`\>
 
-Defined in: [src/sleep.ts:12](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/sleep.ts#L12)
+Defined in: [src/sleep.ts:12](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/sleep.ts#L12)
 
 Suspends execution for a specified number of milliseconds
 

package/docs/functions/stringifyYaml.md

@@ -6,9 +6,9 @@
 
 # Function: stringifyYaml()
 
-> **stringifyYaml**(`content`, `options`?): `string`
+> **stringifyYaml**(`content`, `options?`): `string`
 
-Defined in: [src/yaml.ts:85](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/yaml.ts#L85)
+Defined in: [src/yaml.ts:85](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/yaml.ts#L85)
 
 Converts a JavaScript object into a YAML string with optional custom tags.
 

package/docs/functions/toCamelCase.md

@@ -8,7 +8,7 @@
 
 > **toCamelCase**(`str`): `string`
 
-Defined in: [src/to-camel-case.ts:17](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/to-camel-case.ts#L17)
+Defined in: [src/to-camel-case.ts:17](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/to-camel-case.ts#L17)
 
 Converts a string to camelCase.
 

package/docs/functions/toCapitalCase.md

@@ -8,7 +8,7 @@
 
 > **toCapitalCase**(`str`): `string`
 
-Defined in: [src/to-capital-case.ts:17](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/to-capital-case.ts#L17)
+Defined in: [src/to-capital-case.ts:17](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/to-capital-case.ts#L17)
 
 Converts a string to capital case, where the first letter of each word is capitalized
 and the rest are in lowercase. Words are separated by spaces, hyphens, or underscores.

package/docs/functions/toPascalCase.md

@@ -8,7 +8,7 @@
 
 > **toPascalCase**(`str`): `string`
 
-Defined in: [src/to-pascal-case.ts:16](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/to-pascal-case.ts#L16)
+Defined in: [src/to-pascal-case.ts:16](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/to-pascal-case.ts#L16)
 
 Converts a string to PascalCase.
 

package/docs/functions/traverseFolder.md

@@ -8,7 +8,7 @@
 
 > **traverseFolder**(`directoryPath`, `fileHandler`): `Promise`\<`void`\>
 
-Defined in: [src/traverse-folder.ts:38](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/traverse-folder.ts#L38)
+Defined in: [src/traverse-folder.ts:38](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/traverse-folder.ts#L38)
 
 Traverses a folder asynchronously and applies a handler to each file or directory.
 

package/docs/functions/traverseFolderSync.md

@@ -8,7 +8,7 @@
 
 > **traverseFolderSync**(`directoryPath`, `fileHandler`): `void`
 
-Defined in: [src/traverse-folder.ts:76](https://github.com/isdk/util.js/blob/f6ac1e1b241d01211870dd55d000c1e9d4daa404/src/traverse-folder.ts#L76)
+Defined in: [src/traverse-folder.ts:76](https://github.com/isdk/util.js/blob/1244ecc63e69dca791e24e154694c362d05c92c5/src/traverse-folder.ts#L76)
 
 Traverses a folder synchronously and applies a handler to each file or directory.