@ls-stack/utils 3.40.0 → 3.42.0

package/docs/mutationUtils.md

@@ -1,44 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / mutationUtils
-
-# mutationUtils
-
-## Functions
-
-### updateObject()
-
-```ts
-function updateObject<T>(object, updates): void;
-```
-
-Defined in: [packages/utils/src/mutationUtils.ts:10](https://github.com/lucasols/utils/blob/main/packages/utils/src/mutationUtils.ts#L10)
-
-Updates an object with a new set of values. undefined values are ignored in the updates object
-and deep equal values are not updated.
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### object
-
-The object to update.
-
-`undefined` | `null` | `T`
-
-##### updates
-
-`Partial`\<`T`\>
-
-The new values to update the object with.
-
-#### Returns
-
-`void`

package/docs/objUtils.md

@@ -1,237 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / objUtils
-
-# objUtils
-
-## Functions
-
-### looseGetObjectProperty()
-
-```ts
-function looseGetObjectProperty<T>(obj, key): undefined | T[keyof T];
-```
-
-Defined in: [packages/utils/src/objUtils.ts:53](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L53)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### obj
-
-`T`
-
-##### key
-
-`string`
-
-#### Returns
-
-`undefined` \| `T`\[keyof `T`\]
-
-***
-
-### mapArrayToObject()
-
-```ts
-function mapArrayToObject<T, K, O>(array, mapper): Record<K, O>;
-```
-
-Defined in: [packages/utils/src/objUtils.ts:21](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L21)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-##### K
-
-`K` *extends* `string`
-
-##### O
-
-`O`
-
-#### Parameters
-
-##### array
-
-`T`[]
-
-##### mapper
-
-(`item`, `index`) => \[`K`, `O`\]
-
-#### Returns
-
-`Record`\<`K`, `O`\>
-
-***
-
-### mapObjectToObject()
-
-```ts
-function mapObjectToObject<I, K, O>(obj, mapper): Record<K, O>;
-```
-
-Defined in: [packages/utils/src/objUtils.ts:28](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L28)
-
-#### Type Parameters
-
-##### I
-
-`I` *extends* `Record`\<`string` \| `number` \| `symbol`, `unknown`\>
-
-##### K
-
-`K` *extends* `string` \| `number` \| `symbol`
-
-##### O
-
-`O`
-
-#### Parameters
-
-##### obj
-
-`I`
-
-##### mapper
-
-(`key`, `value`) => \[`K`, `O`\]
-
-#### Returns
-
-`Record`\<`K`, `O`\>
-
-***
-
-### ~~objectTypedEntries()~~
-
-```ts
-function objectTypedEntries<T>(obj): [Extract<keyof T, string>, T[keyof T]][];
-```
-
-Defined in: [packages/utils/src/objUtils.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L5)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### obj
-
-`T`
-
-#### Returns
-
-\[`Extract`\<keyof `T`, `string`\>, `T`\[keyof `T`\]\][]
-
-#### Deprecated
-
-use typedObjectEntries from @ls-stack/utils/typingFnUtils instead
-
-***
-
-### omit()
-
-```ts
-function omit<T, K>(obj, keys): Omit<T, K>;
-```
-
-Defined in: [packages/utils/src/objUtils.ts:38](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L38)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-##### K
-
-`K` *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-##### obj
-
-`T`
-
-##### keys
-
-`K`[]
-
-#### Returns
-
-`Omit`\<`T`, `K`\>
-
-***
-
-### pick()
-
-```ts
-function pick<T, K>(obj, keys): Pick<T, K>;
-```
-
-Defined in: [packages/utils/src/objUtils.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L9)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-##### K
-
-`K` *extends* `string` \| `number` \| `symbol`
-
-#### Parameters
-
-##### obj
-
-`T`
-
-##### keys
-
-`K`[]
-
-#### Returns
-
-`Pick`\<`T`, `K`\>
-
-***
-
-### rejectObjUndefinedValues()
-
-```ts
-function rejectObjUndefinedValues<T>(obj): T;
-```
-
-Defined in: [packages/utils/src/objUtils.ts:60](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L60)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-#### Parameters
-
-##### obj
-
-`T`
-
-#### Returns
-
-`T`

package/docs/parallelAsyncCalls/-internal-.md

@@ -1,347 +0,0 @@
-[**@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:66](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L66)
-
-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:154](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L154)
-
-###### 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:99](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L99)
-
-###### 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

@@ -1,45 +0,0 @@
-[**@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:217](https://github.com/lucasols/utils/blob/main/packages/utils/src/parallelAsyncCalls.ts#L217)
-
-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.