@ls-stack/utils 3.17.1 → 3.19.0

package/docs/concurrentCalls/-internal-.md

@@ -0,0 +1,416 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / [concurrentCalls](README.md) / \<internal\>
+
+# \<internal\>
+
+## Classes
+
+### ConcurrentCalls\<R, E\>
+
+Defined in: [packages/utils/src/concurrentCalls.ts:32](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L32)
+
+#### Type Parameters
+
+##### R
+
+`R` = `unknown`
+
+##### E
+
+`E` *extends* `Error` = `Error`
+
+#### Constructors
+
+##### Constructor
+
+```ts
+new ConcurrentCalls<R, E>(): ConcurrentCalls<R, E>;
+```
+
+###### Returns
+
+[`ConcurrentCalls`](#concurrentcalls)\<`R`, `E`\>
+
+#### Methods
+
+##### add()
+
+```ts
+add(...calls): this;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:36](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L36)
+
+###### Parameters
+
+###### calls
+
+...[`Action`](#action)\<`R`, `E`\>[]
+
+###### Returns
+
+`this`
+
+##### resultifyAdd()
+
+```ts
+resultifyAdd(...calls): this;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:42](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L42)
+
+###### Parameters
+
+###### calls
+
+...(`Promise`\<`R`\> \| () => `R` \| () => `Promise`\<`R`\>)[]
+
+###### Returns
+
+`this`
+
+##### runAll()
+
+```ts
+runAll(__namedParameters): Promise<Result<R[], E>>;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:74](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L74)
+
+###### Parameters
+
+###### \_\_namedParameters
+
+[`RunProps`](#runprops) = `{}`
+
+###### Returns
+
+`Promise`\<`Result`\<`R`[], `E`\>\>
+
+##### runAllSettled()
+
+```ts
+runAllSettled(__namedParameters): Promise<{
+  aggregatedError: null | AggregateError;
+  allFailed: boolean;
+  failures: E[];
+  succeeded: R[];
+  total: number;
+}>;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:112](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L112)
+
+###### Parameters
+
+###### \_\_namedParameters
+
+[`RunProps`](#runprops) = `{}`
+
+###### Returns
+
+`Promise`\<\{
+  `aggregatedError`: `null` \| `AggregateError`;
+  `allFailed`: `boolean`;
+  `failures`: `E`[];
+  `succeeded`: `R`[];
+  `total`: `number`;
+\}\>
+
+***
+
+### ConcurrentCallsWithMetadata\<M, R, E\>
+
+Defined in: [packages/utils/src/concurrentCalls.ts:184](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L184)
+
+#### Type Parameters
+
+##### M
+
+`M` *extends* [`ValidMetadata`](#validmetadata)
+
+##### R
+
+`R` = `unknown`
+
+##### E
+
+`E` *extends* `Error` = `Error`
+
+#### Constructors
+
+##### Constructor
+
+```ts
+new ConcurrentCallsWithMetadata<M, R, E>(): ConcurrentCallsWithMetadata<M, R, E>;
+```
+
+###### Returns
+
+[`ConcurrentCallsWithMetadata`](#concurrentcallswithmetadata)\<`M`, `R`, `E`\>
+
+#### Methods
+
+##### add()
+
+```ts
+add(...calls): this;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:192](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L192)
+
+###### Parameters
+
+###### calls
+
+...`object`[]
+
+###### Returns
+
+`this`
+
+##### resultifyAdd()
+
+```ts
+resultifyAdd(...items): this;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:206](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L206)
+
+###### Parameters
+
+###### items
+
+...`object`[]
+
+###### Returns
+
+`this`
+
+##### runAll()
+
+```ts
+runAll(__namedParameters): Promise<Result<SucceededCall<R, M>[], FailedCall<M, E>>>;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:227](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L227)
+
+###### Parameters
+
+###### \_\_namedParameters
+
+[`RunProps`](#runprops) = `{}`
+
+###### Returns
+
+`Promise`\<`Result`\<[`SucceededCall`](#succeededcall)\<`R`, `M`\>[], [`FailedCall`](#failedcall)\<`M`, `E`\>\>\>
+
+##### runAllSettled()
+
+```ts
+runAllSettled(__namedParameters): Promise<{
+  aggregatedError: null | AggregateError;
+  allFailed: boolean;
+  failed: FailedCall<M, E>[];
+  failures: FailedCall<M, E>[];
+  results: SettledResultWithMetadata<R, M, E>[];
+  succeeded: SucceededCall<R, M>[];
+  total: number;
+}>;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:274](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L274)
+
+###### Parameters
+
+###### \_\_namedParameters
+
+[`RunProps`](#runprops) = `{}`
+
+###### Returns
+
+`Promise`\<\{
+  `aggregatedError`: `null` \| `AggregateError`;
+  `allFailed`: `boolean`;
+  `failed`: [`FailedCall`](#failedcall)\<`M`, `E`\>[];
+  `failures`: [`FailedCall`](#failedcall)\<`M`, `E`\>[];
+  `results`: [`SettledResultWithMetadata`](#settledresultwithmetadata)\<`R`, `M`, `E`\>[];
+  `succeeded`: [`SucceededCall`](#succeededcall)\<`R`, `M`\>[];
+  `total`: `number`;
+\}\>
+
+## Type Aliases
+
+### Action\<R, E\>
+
+```ts
+type Action<R, E> = 
+  | () => Promise<Result<R, E>>
+| Promise<Result<R, E>>;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:23](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L23)
+
+#### Type Parameters
+
+##### R
+
+`R`
+
+##### E
+
+`E` *extends* `Error`
+
+***
+
+### FailedCall\<M, E\>
+
+```ts
+type FailedCall<M, E> = object;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:18](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L18)
+
+#### Type Parameters
+
+##### M
+
+`M`
+
+##### E
+
+`E` *extends* `Error` = `Error`
+
+#### Properties
+
+##### error
+
+```ts
+error: E;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:20](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L20)
+
+##### metadata
+
+```ts
+metadata: M;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:19](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L19)
+
+***
+
+### RunProps
+
+```ts
+type RunProps = object;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L9)
+
+#### Properties
+
+##### delayStart()?
+
+```ts
+optional delayStart: (index) => number;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:10](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L10)
+
+###### Parameters
+
+###### index
+
+`number`
+
+###### Returns
+
+`number`
+
+***
+
+### SettledResultWithMetadata\<R, M, E\>
+
+```ts
+type SettledResultWithMetadata<R, M, E> = 
+  | {
+  error: false;
+  metadata: M;
+  ok: true;
+  value: R;
+}
+  | {
+  error: E;
+  metadata: M;
+  ok: false;
+};
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:28](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L28)
+
+#### Type Parameters
+
+##### R
+
+`R`
+
+##### M
+
+`M`
+
+##### E
+
+`E` *extends* `Error` = `Error`
+
+***
+
+### SucceededCall\<R, M\>
+
+```ts
+type SucceededCall<R, M> = object;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:14](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L14)
+
+#### Type Parameters
+
+##### R
+
+`R`
+
+##### M
+
+`M`
+
+#### Properties
+
+##### metadata
+
+```ts
+metadata: M;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:16](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L16)
+
+##### value
+
+```ts
+value: R;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:15](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L15)
+
+***
+
+### ValidMetadata
+
+```ts
+type ValidMetadata = string | number | boolean | Record<string, unknown>;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L7)

package/docs/concurrentCalls/README.md

@@ -0,0 +1,77 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / concurrentCalls
+
+# concurrentCalls
+
+## Modules
+
+- [\<internal\>](-internal-.md)
+
+## Functions
+
+### concurrentCalls()
+
+```ts
+function concurrentCalls<R, E>(): ConcurrentCalls<R, E>;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:180](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L180)
+
+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.
+
+##### E
+
+`E` *extends* `Error` = `Error`
+
+The type of the error.
+
+#### Returns
+
+[`ConcurrentCalls`](-internal-.md#concurrentcalls)\<`R`, `E`\>
+
+***
+
+### concurrentCallsWithMetadata()
+
+```ts
+function concurrentCallsWithMetadata<M, R, E>(): ConcurrentCallsWithMetadata<M, R, E>;
+```
+
+Defined in: [packages/utils/src/concurrentCalls.ts:373](https://github.com/lucasols/utils/blob/main/packages/utils/src/concurrentCalls.ts#L373)
+
+Executes multiple asynchronous calls concurrently 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.
+
+##### E
+
+`E` *extends* `Error` = `Error`
+
+The type of the error from individual Result objects.
+
+#### Returns
+
+[`ConcurrentCallsWithMetadata`](-internal-.md#concurrentcallswithmetadata)\<`M`, `R`, `E`\>

package/docs/consoleFmt.md

@@ -0,0 +1,91 @@
+[**@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
+
+`"green"` | `"red"` | `"blue"` | `"yellow"` | `"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
+
+`"green"` | `"red"` | `"blue"` | `"yellow"` | `"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

@@ -0,0 +1,27 @@
+[**@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

@@ -0,0 +1,73 @@
+[**@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

@@ -0,0 +1,31 @@
+[**@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)