@ls-stack/utils 3.18.0 → 3.20.0

package/docs/parallelAsyncCalls/-internal-.md

@@ -0,0 +1,347 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / [parallelAsyncCalls](README.md) / \<internal\>
+
+# \<internal\>
+
+## Classes
+
+### ParallelAsyncResultCalls\<M, R\>
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:39](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L39)
+
+#### Type Parameters
+
+##### M
+
+`M` *extends* [`ValidMetadata`](#validmetadata) \| `undefined` = `undefined`
+
+##### R
+
+`R` = `unknown`
+
+#### Constructors
+
+##### Constructor
+
+```ts
+new ParallelAsyncResultCalls<M, R>(): ParallelAsyncResultCalls<M, R>;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:49](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L49)
+
+###### Returns
+
+[`ParallelAsyncResultCalls`](#parallelasyncresultcalls)\<`M`, `R`\>
+
+#### Properties
+
+##### alreadyRun
+
+```ts
+alreadyRun: boolean = false;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:47](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L47)
+
+#### Methods
+
+##### add()
+
+```ts
+add(call): ParallelAsyncResultCalls<M, R>;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L51)
+
+###### Parameters
+
+###### call
+
+`M` *extends* `undefined` ? () => `Promise`\<`Result`\<`R`\>\> : `object`
+
+###### Returns
+
+[`ParallelAsyncResultCalls`](#parallelasyncresultcalls)\<`M`, `R`\>
+
+##### addTuple()
+
+```ts
+addTuple<T>(...calls): object;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:63](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L63)
+
+adds calls return tuples with inferred results
+
+###### Type Parameters
+
+###### T
+
+`T` *extends* `M` *extends* `undefined` ? () => `Promise`\<`Result`\<`R`\>\> : `object`[]
+
+###### Parameters
+
+###### calls
+
+...`T`
+
+###### Returns
+
+`object`
+
+###### runAll()
+
+```ts
+runAll: (props?) => Promise<Result<{ [I in string | number | symbol]: TupleRunAllSuccess<T[I<I>]> }, TupleRunAllFailed<T[number]>>>;
+```
+
+###### Parameters
+
+###### props?
+
+[`RunProps`](#runprops)
+
+###### Returns
+
+`Promise`\<`Result`\<\{ \[I in string \| number \| symbol\]: TupleRunAllSuccess\<T\[I\<I\>\]\> \}, [`TupleRunAllFailed`](#tuplerunallfailed)\<`T`\[`number`\]\>\>\>
+
+###### runAllSettled()
+
+```ts
+runAllSettled: (props?) => Promise<{
+  allFailed: boolean;
+  results: { [I in string | number | symbol]: TupleRunAllSettled<T[I<I>]> };
+}>;
+```
+
+###### Parameters
+
+###### props?
+
+[`RunProps`](#runprops)
+
+###### Returns
+
+`Promise`\<\{
+  `allFailed`: `boolean`;
+  `results`: \{ \[I in string \| number \| symbol\]: TupleRunAllSettled\<T\[I\<I\>\]\> \};
+\}\>
+
+##### runAll()
+
+```ts
+runAll(__namedParameters): Promise<Result<Succeeded<R, M>[], {
+  error: Error;
+  metadata: M;
+}>>;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:151](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L151)
+
+###### Parameters
+
+###### \_\_namedParameters
+
+###### delayStart?
+
+(`index`) => `number`
+
+###### Returns
+
+`Promise`\<`Result`\<[`Succeeded`](#succeeded)\<`R`, `M`\>[], \{
+  `error`: `Error`;
+  `metadata`: `M`;
+\}\>\>
+
+##### runAllSettled()
+
+```ts
+runAllSettled(__namedParameters): Promise<{
+  allFailed: boolean;
+  failed: Failed<M>[];
+  results: (Failed<M> | Succeeded<R, M>)[];
+  succeeded: Succeeded<R, M>[];
+}>;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:96](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L96)
+
+###### Parameters
+
+###### \_\_namedParameters
+
+[`RunProps`](#runprops) = `{}`
+
+###### Returns
+
+`Promise`\<\{
+  `allFailed`: `boolean`;
+  `failed`: [`Failed`](#failed)\<`M`\>[];
+  `results`: ([`Failed`](#failed)\<`M`\> \| [`Succeeded`](#succeeded)\<`R`, `M`\>)[];
+  `succeeded`: [`Succeeded`](#succeeded)\<`R`, `M`\>[];
+\}\>
+
+## Type Aliases
+
+### Failed\<M\>
+
+```ts
+type Failed<M> = object;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:30](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L30)
+
+#### Type Parameters
+
+##### M
+
+`M`
+
+#### Properties
+
+##### error
+
+```ts
+error: Error;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:32](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L32)
+
+##### metadata
+
+```ts
+metadata: M;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:31](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L31)
+
+***
+
+### RunProps
+
+```ts
+type RunProps = object;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:26](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L26)
+
+#### Properties
+
+##### delayStart()?
+
+```ts
+optional delayStart: (index) => number;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:27](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L27)
+
+###### Parameters
+
+###### index
+
+`number`
+
+###### Returns
+
+`number`
+
+***
+
+### Succeeded\<R, M\>
+
+```ts
+type Succeeded<R, M> = object;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:34](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L34)
+
+#### Type Parameters
+
+##### R
+
+`R`
+
+##### M
+
+`M`
+
+#### Properties
+
+##### metadata
+
+```ts
+metadata: M;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:36](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L36)
+
+##### value
+
+```ts
+value: R;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:35](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L35)
+
+***
+
+### TupleRunAllFailed\<T\>
+
+```ts
+type TupleRunAllFailed<T> = T extends () => Promise<Result<any>> ? object : T extends object ? object : never;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:13](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L13)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+***
+
+### TupleRunAllSettled\<T\>
+
+```ts
+type TupleRunAllSettled<T> = T extends () => Promise<Result<infer V>> ? 
+  | Succeeded<V, undefined>
+  | Failed<undefined> : T extends object ? Succeeded<V, M> | Failed<M> : never;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:19](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L19)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+***
+
+### TupleRunAllSuccess\<T\>
+
+```ts
+type TupleRunAllSuccess<T> = T extends () => Promise<Result<infer V>> ? Succeeded<V, undefined> : T extends object ? Succeeded<V, M> : never;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L7)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+***
+
+### ValidMetadata
+
+```ts
+type ValidMetadata = string | number | boolean | Record<string, unknown>;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L5)

package/docs/parallelAsyncCalls/README.md

@@ -0,0 +1,45 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / parallelAsyncCalls
+
+# parallelAsyncCalls
+
+## Modules
+
+- [\<internal\>](-internal-.md)
+
+## Functions
+
+### ~~parallelAsyncCalls()~~
+
+```ts
+function parallelAsyncCalls<M, R>(): ParallelAsyncResultCalls<M, R>;
+```
+
+Defined in: [packages/utils/src/parallelAsyncCalls.ts:214](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L214)
+
+Executes multiple asynchronous calls in parallel and collects the results in a easier to use format.
+
+#### Type Parameters
+
+##### M
+
+`M` *extends* `undefined` \| [`ValidMetadata`](-internal-.md#validmetadata) = `undefined`
+
+The type of the call metadata.
+
+##### R
+
+`R` = `unknown`
+
+The type of the result value.
+
+#### Returns
+
+[`ParallelAsyncResultCalls`](-internal-.md#parallelasyncresultcalls)\<`M`, `R`\>
+
+#### Deprecated
+
+Use concurrentAsyncCalls instead.

package/docs/promiseUtils/-internal-.md

@@ -0,0 +1,69 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / [promiseUtils](README.md) / \<internal\>
+
+# \<internal\>
+
+## Type Aliases
+
+### Deferred\<T\>
+
+```ts
+type Deferred<T> = object;
+```
+
+Defined in: [packages/utils/src/promiseUtils.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/promiseUtils.ts#L1)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Properties
+
+##### promise
+
+```ts
+promise: Promise<T>;
+```
+
+Defined in: [packages/utils/src/promiseUtils.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/promiseUtils.ts#L4)
+
+##### reject()
+
+```ts
+reject: (reason) => void;
+```
+
+Defined in: [packages/utils/src/promiseUtils.ts:3](https://github.com/lucasols/utils/blob/main/packages/utils/src/promiseUtils.ts#L3)
+
+###### Parameters
+
+###### reason
+
+`unknown`
+
+###### Returns
+
+`void`
+
+##### resolve()
+
+```ts
+resolve: (value) => void;
+```
+
+Defined in: [packages/utils/src/promiseUtils.ts:2](https://github.com/lucasols/utils/blob/main/packages/utils/src/promiseUtils.ts#L2)
+
+###### Parameters
+
+###### value
+
+`T` | `PromiseLike`\<`T`\>
+
+###### Returns
+
+`void`

package/docs/promiseUtils/README.md

@@ -0,0 +1,31 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / promiseUtils
+
+# promiseUtils
+
+## Modules
+
+- [\<internal\>](-internal-.md)
+
+## Functions
+
+### defer()
+
+```ts
+function defer<T>(): Deferred<T>;
+```
+
+Defined in: [packages/utils/src/promiseUtils.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/promiseUtils.ts#L7)
+
+#### Type Parameters
+
+##### T
+
+`T` = `void`
+
+#### Returns
+
+[`Deferred`](-internal-.md#deferred)\<`T`\>

package/docs/retryOnError.md

@@ -0,0 +1,67 @@
+[**@ls-stack/utils**](README.md)
+
+***
+
+[@ls-stack/utils](modules.md) / retryOnError
+
+# retryOnError
+
+## Functions
+
+### retryOnError()
+
+```ts
+function retryOnError<T>(
+   fn, 
+   maxRetries, 
+   options, 
+retry): Promise<T>;
+```
+
+Defined in: [packages/utils/src/retryOnError.ts:3](https://github.com/lucasols/utils/blob/main/packages/utils/src/retryOnError.ts#L3)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### fn
+
+() => `Promise`\<`T`\>
+
+##### maxRetries
+
+`number`
+
+##### options
+
+###### debugId?
+
+`string`
+
+###### delayBetweenRetriesMs?
+
+`number` \| (`retry`) => `number`
+
+###### maxErrorDurationMs?
+
+`number`
+
+###### retryCondition?
+
+(`error`) => 
+  \| `boolean`
+  \| \{
+  `maxErrorDurationMs`: `number`;
+\}
+
+##### retry
+
+`number` = `0`
+
+#### Returns
+
+`Promise`\<`T`\>

package/docs/runShellCmd/-internal-.md

@@ -0,0 +1,111 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / [runShellCmd](README.md) / \<internal\>
+
+# \<internal\>
+
+## Type Aliases
+
+### CmdResult
+
+```ts
+type CmdResult = object;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:3](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L3)
+
+#### Properties
+
+##### error
+
+```ts
+error: boolean;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:6](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L6)
+
+##### label
+
+```ts
+label: string | null;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L4)
+
+##### out
+
+```ts
+out: string;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L5)
+
+##### stderr
+
+```ts
+stderr: string;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:8](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L8)
+
+##### stdout
+
+```ts
+stdout: string;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L7)
+
+***
+
+### RunCmdOptions
+
+```ts
+type RunCmdOptions = object;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:13](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L13)
+
+#### Properties
+
+##### cwd?
+
+```ts
+optional cwd: string;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:16](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L16)
+
+##### mock?
+
+```ts
+optional mock: CmdResult;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:14](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L14)
+
+##### noCiColorForce?
+
+```ts
+optional noCiColorForce: boolean;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:18](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L18)
+
+##### silent?
+
+```ts
+optional silent: boolean | "timeOnly";
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:15](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L15)
+
+##### throwOnError?
+
+```ts
+optional throwOnError: boolean;
+```
+
+Defined in: [packages/utils/src/runShellCmd.ts:17](https://github.com/lucasols/utils/blob/main/packages/utils/src/runShellCmd.ts#L17)