@ls-stack/utils 3.39.0 → 3.41.0

package/docs/concurrentCalls/README.md

@@ -1,299 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / concurrentCalls
-
-# concurrentCalls
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Classes
-
-### ConcurrentCallsAggregateError
-
-Defined in: [packages/utils/src/concurrentCalls.ts:38](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L38)
-
-#### Extends
-
-- `AggregateError`
-
-#### Constructors
-
-##### Constructor
-
-```ts
-new ConcurrentCallsAggregateError(
-   errors, 
-   total, 
-   failed): ConcurrentCallsAggregateError;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:43](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L43)
-
-###### Parameters
-
-###### errors
-
-`ResultValidErrors`[]
-
-###### total
-
-`number`
-
-###### failed
-
-`number`
-
-###### Returns
-
-[`ConcurrentCallsAggregateError`](#concurrentcallsaggregateerror)
-
-###### Overrides
-
-```ts
-AggregateError.constructor
-```
-
-#### Properties
-
-##### errors
-
-```ts
-errors: ResultValidErrors[] = [];
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:39](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L39)
-
-###### Overrides
-
-```ts
-AggregateError.errors
-```
-
-##### failed
-
-```ts
-failed: number = 0;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:41](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L41)
-
-##### total
-
-```ts
-total: number = 0;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:40](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L40)
-
-***
-
-### ConcurrentCallsWithMetadataAggregateError\<M\>
-
-Defined in: [packages/utils/src/concurrentCalls.ts:62](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L62)
-
-#### Extends
-
-- `AggregateError`
-
-#### Type Parameters
-
-##### M
-
-`M` *extends* [`ValidMetadata`](-internal-.md#validmetadata)
-
-#### Constructors
-
-##### Constructor
-
-```ts
-new ConcurrentCallsWithMetadataAggregateError<M>(
-   errors, 
-   total, 
-failed): ConcurrentCallsWithMetadataAggregateError<M>;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:70](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L70)
-
-###### Parameters
-
-###### errors
-
-`object`[]
-
-###### total
-
-`number`
-
-###### failed
-
-`number`
-
-###### Returns
-
-[`ConcurrentCallsWithMetadataAggregateError`](#concurrentcallswithmetadataaggregateerror)\<`M`\>
-
-###### Overrides
-
-```ts
-AggregateError.constructor
-```
-
-#### Properties
-
-##### errors
-
-```ts
-errors: ResultValidErrors[] = [];
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:65](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L65)
-
-###### Overrides
-
-```ts
-AggregateError.errors
-```
-
-##### errorsWithMetadata
-
-```ts
-errorsWithMetadata: object[] = [];
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:66](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L66)
-
-###### error
-
-```ts
-error: ResultValidErrors;
-```
-
-###### metadata
-
-```ts
-metadata: M;
-```
-
-##### failed
-
-```ts
-failed: number = 0;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:68](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L68)
-
-##### total
-
-```ts
-total: number = 0;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:67](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L67)
-
-## Functions
-
-### concurrentCalls()
-
-```ts
-function concurrentCalls<R>(): ConcurrentCalls<R, Error>;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:273](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L273)
-
-Executes multiple asynchronous calls concurrently and collects the results in a easier to use format.
-
-#### Type Parameters
-
-##### R
-
-`R` = `unknown`
-
-The type of the result value.
-
-#### Returns
-
-[`ConcurrentCalls`](-internal-.md#concurrentcalls)\<`R`, `Error`\>
-
-***
-
-### concurrentCallsWithMetadata()
-
-```ts
-function concurrentCallsWithMetadata<M, R>(): ConcurrentCallsWithMetadata<M, R, Error>;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:472](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L472)
-
-Executes multiple asynchronous calls concurrently with metadata for each call and collects the results in a easier to use format.
-
-#### Type Parameters
-
-##### M
-
-`M` *extends* [`ValidMetadata`](-internal-.md#validmetadata)
-
-The type of the call metadata.
-
-##### R
-
-`R` = `unknown`
-
-The type of the result value.
-
-#### Returns
-
-[`ConcurrentCallsWithMetadata`](-internal-.md#concurrentcallswithmetadata)\<`M`, `R`, `Error`\>
-
-***
-
-### concurrentResultCalls()
-
-```ts
-function concurrentResultCalls<ResultFn>(): ConcurrentCalls<ValueFromResult<Awaited<ReturnType<ResultFn>>>, ErrorFromResult<Awaited<ReturnType<ResultFn>>>>;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:487](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L487)
-
-Executes multiple asynchronous result calls concurrently and collects the results in a easier to use format.
-
-#### Type Parameters
-
-##### ResultFn
-
-`ResultFn` *extends* (...`args`) => `Promise`\<`Result`\<`unknown`, `ResultValidErrors`\>\>
-
-#### Returns
-
-[`ConcurrentCalls`](-internal-.md#concurrentcalls)\<[`ValueFromResult`](-internal-.md#valuefromresult)\<`Awaited`\<`ReturnType`\<`ResultFn`\>\>\>, [`ErrorFromResult`](-internal-.md#errorfromresult)\<`Awaited`\<`ReturnType`\<`ResultFn`\>\>\>\>
-
-***
-
-### concurrentResultsWithMetadata()
-
-```ts
-function concurrentResultsWithMetadata<M, ResultFn>(): ConcurrentCallsWithMetadata<M, ValueFromResult<Awaited<ReturnType<ResultFn>>>, ErrorFromResult<Awaited<ReturnType<ResultFn>>>>;
-```
-
-Defined in: [packages/utils/src/concurrentCalls.ts:504](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L504)
-
-Executes multiple asynchronous result calls concurrently with metadata for each call and collects the results in a easier to use format.
-
-#### Type Parameters
-
-##### M
-
-`M` *extends* [`ValidMetadata`](-internal-.md#validmetadata)
-
-##### ResultFn
-
-`ResultFn` *extends* (...`args`) => `Promise`\<`Result`\<`unknown`, `ResultValidErrors`\>\>
-
-The type of the result function that will be called.
-
-#### Returns
-
-[`ConcurrentCallsWithMetadata`](-internal-.md#concurrentcallswithmetadata)\<`M`, [`ValueFromResult`](-internal-.md#valuefromresult)\<`Awaited`\<`ReturnType`\<`ResultFn`\>\>\>, [`ErrorFromResult`](-internal-.md#errorfromresult)\<`Awaited`\<`ReturnType`\<`ResultFn`\>\>\>\>

package/docs/consoleFmt.md

@@ -1,91 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / consoleFmt
-
-# consoleFmt
-
-## Variables
-
-### consoleFmt
-
-```ts
-const consoleFmt: object;
-```
-
-Defined in: [packages/utils/src/consoleFmt.ts:56](https://github.com/lucasols/utils/blob/main/packages/utils/src/consoleFmt.ts#L56)
-
-#### Type declaration
-
-##### bgColor()
-
-```ts
-bgColor: (color, text) => string;
-```
-
-###### Parameters
-
-###### color
-
-`"red"` | `"green"` | `"yellow"` | `"blue"` | `"magenta"` | `"cyan"` | `"white"` | `"black"` | `"gray"` | `"brightRed"` | `"brightGreen"` | `"brightYellow"` | `"brightBlue"` | `"brightMagenta"` | `"brightCyan"` | `"brightWhite"`
-
-###### text
-
-`string`
-
-###### Returns
-
-`string`
-
-##### bold()
-
-```ts
-bold: (text) => string;
-```
-
-###### Parameters
-
-###### text
-
-`string`
-
-###### Returns
-
-`string`
-
-##### color()
-
-```ts
-color: (color, text) => string = consoleColors;
-```
-
-###### Parameters
-
-###### color
-
-`"red"` | `"green"` | `"yellow"` | `"blue"` | `"magenta"` | `"cyan"` | `"white"` | `"black"` | `"gray"` | `"brightRed"` | `"brightGreen"` | `"brightYellow"` | `"brightBlue"` | `"brightMagenta"` | `"brightCyan"` | `"brightWhite"`
-
-###### text
-
-`string`
-
-###### Returns
-
-`string`
-
-##### underline()
-
-```ts
-underline: (text) => string;
-```
-
-###### Parameters
-
-###### text
-
-`string`
-
-###### Returns
-
-`string`

package/docs/conversions.md

@@ -1,27 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / conversions
-
-# conversions
-
-## Functions
-
-### bytesToHumanReadable()
-
-```ts
-function bytesToHumanReadable(bytes): string;
-```
-
-Defined in: [packages/utils/src/conversions.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/conversions.ts#L1)
-
-#### Parameters
-
-##### bytes
-
-`number`
-
-#### Returns
-
-`string`

package/docs/createThrottleController/-internal-.md

@@ -1,73 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / [createThrottleController](README.md) / \<internal\>
-
-# \<internal\>
-
-## Type Aliases
-
-### Options
-
-```ts
-type Options = object;
-```
-
-Defined in: [packages/utils/src/createThrottleController.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/createThrottleController.ts#L5)
-
-#### Properties
-
-##### cleanupCheckSecsInterval?
-
-```ts
-optional cleanupCheckSecsInterval: number;
-```
-
-Defined in: [packages/utils/src/createThrottleController.ts:8](https://github.com/lucasols/utils/blob/main/packages/utils/src/createThrottleController.ts#L8)
-
-##### maxCalls
-
-```ts
-maxCalls: number;
-```
-
-Defined in: [packages/utils/src/createThrottleController.ts:6](https://github.com/lucasols/utils/blob/main/packages/utils/src/createThrottleController.ts#L6)
-
-##### per
-
-```ts
-per: DurationObj;
-```
-
-Defined in: [packages/utils/src/createThrottleController.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/createThrottleController.ts#L7)
-
-***
-
-### ThrottleController
-
-```ts
-type ThrottleController = object;
-```
-
-Defined in: [packages/utils/src/createThrottleController.ts:11](https://github.com/lucasols/utils/blob/main/packages/utils/src/createThrottleController.ts#L11)
-
-#### Properties
-
-##### shouldSkip()
-
-```ts
-shouldSkip: (callId?) => boolean;
-```
-
-Defined in: [packages/utils/src/createThrottleController.ts:12](https://github.com/lucasols/utils/blob/main/packages/utils/src/createThrottleController.ts#L12)
-
-###### Parameters
-
-###### callId?
-
-`string` | `number` | (`string` \| `number`)[]
-
-###### Returns
-
-`boolean`

package/docs/createThrottleController/README.md

@@ -1,31 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / createThrottleController
-
-# createThrottleController
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Functions
-
-### createThrottleController()
-
-```ts
-function createThrottleController(__namedParameters): ThrottleController;
-```
-
-Defined in: [packages/utils/src/createThrottleController.ts:20](https://github.com/lucasols/utils/blob/main/packages/utils/src/createThrottleController.ts#L20)
-
-#### Parameters
-
-##### \_\_namedParameters
-
-[`Options`](-internal-.md#options)
-
-#### Returns
-
-[`ThrottleController`](-internal-.md#throttlecontroller)

package/docs/debounce.md

@@ -1,188 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / debounce
-
-# debounce
-
-## Interfaces
-
-### DebouncedFunc()\<T\>
-
-Defined in: [packages/utils/src/debounce.ts:16](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L16)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* (...`args`) => `void`
-
-```ts
-DebouncedFunc(...args): undefined | ReturnType<T>;
-```
-
-Defined in: [packages/utils/src/debounce.ts:26](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L26)
-
-Call the original function, but applying the debounce rules.
-
-If the debounced function can be run immediately, this calls it and returns its return
-value.
-
-Otherwise, it returns the return value of the last invocation, or undefined if the debounced
-function was not invoked yet.
-
-#### Parameters
-
-##### args
-
-...`Parameters`\<`T`\>
-
-#### Returns
-
-`undefined` \| `ReturnType`\<`T`\>
-
-#### Properties
-
-##### cancel()
-
-```ts
-cancel: () => void;
-```
-
-Defined in: [packages/utils/src/debounce.ts:31](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L31)
-
-Throw away any pending invocation of the debounced function.
-
-###### Returns
-
-`void`
-
-##### flush()
-
-```ts
-flush: () => undefined | ReturnType<T>;
-```
-
-Defined in: [packages/utils/src/debounce.ts:40](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L40)
-
-If there is a pending invocation of the debounced function, invoke it immediately and return
-its return value.
-
-Otherwise, return the value from the last invocation, or undefined if the debounced function
-was never invoked.
-
-###### Returns
-
-`undefined` \| `ReturnType`\<`T`\>
-
-## Type Aliases
-
-### DebounceOptions
-
-```ts
-type DebounceOptions = object;
-```
-
-Defined in: [packages/utils/src/debounce.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L1)
-
-#### Properties
-
-##### leading?
-
-```ts
-optional leading: boolean;
-```
-
-Defined in: [packages/utils/src/debounce.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L5)
-
-###### See
-
-_.leading
-
-##### maxWait?
-
-```ts
-optional maxWait: number;
-```
-
-Defined in: [packages/utils/src/debounce.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L9)
-
-###### See
-
-_.maxWait
-
-##### trailing?
-
-```ts
-optional trailing: boolean;
-```
-
-Defined in: [packages/utils/src/debounce.ts:13](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L13)
-
-###### See
-
-_.trailing
-
-## Functions
-
-### debounce()
-
-```ts
-function debounce<T>(
-   func, 
-   wait, 
-options?): DebouncedFunc<T>;
-```
-
-Defined in: [packages/utils/src/debounce.ts:44](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L44)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* (...`args`) => `void`
-
-#### Parameters
-
-##### func
-
-`T`
-
-##### wait
-
-`number`
-
-##### options?
-
-[`DebounceOptions`](#debounceoptions)
-
-#### Returns
-
-[`DebouncedFunc`](#debouncedfunc)\<`T`\>
-
-***
-
-### isDebouncedFn()
-
-```ts
-function isDebouncedFn<T>(fn): fn is T & { cancel: () => void; flush: () => undefined | ReturnType<T> };
-```
-
-Defined in: [packages/utils/src/debounce.ts:176](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L176)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* (...`args`) => `void`
-
-#### Parameters
-
-##### fn
-
-`T`
-
-#### Returns
-
-fn is T & \{ cancel: () =\> void; flush: () =\> undefined \| ReturnType\<T\> \}