@ls-stack/utils 3.39.0 → 3.41.0

package/docs/levenshtein.md

@@ -1,93 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / levenshtein
-
-# levenshtein
-
-## Functions
-
-### getClosestString()
-
-```ts
-function getClosestString(
-   str, 
-   arr, 
-   maxDistance): undefined | string;
-```
-
-Defined in: [packages/utils/src/levenshtein.ts:134](https://github.com/lucasols/utils/blob/main/packages/utils/src/levenshtein.ts#L134)
-
-#### Parameters
-
-##### str
-
-`string`
-
-##### arr
-
-readonly `string`[]
-
-##### maxDistance
-
-`number` = `2`
-
-#### Returns
-
-`undefined` \| `string`
-
-***
-
-### getClosestStringsUpToDist()
-
-```ts
-function getClosestStringsUpToDist(
-   str, 
-   arr, 
-   maxDistance): string[];
-```
-
-Defined in: [packages/utils/src/levenshtein.ts:151](https://github.com/lucasols/utils/blob/main/packages/utils/src/levenshtein.ts#L151)
-
-#### Parameters
-
-##### str
-
-`string`
-
-##### arr
-
-readonly `string`[]
-
-##### maxDistance
-
-`number` = `2`
-
-#### Returns
-
-`string`[]
-
-***
-
-### levenshteinDistance()
-
-```ts
-function levenshteinDistance(a, b): number;
-```
-
-Defined in: [packages/utils/src/levenshtein.ts:119](https://github.com/lucasols/utils/blob/main/packages/utils/src/levenshtein.ts#L119)
-
-#### Parameters
-
-##### a
-
-`string`
-
-##### b
-
-`string`
-
-#### Returns
-
-`number`

package/docs/main.md

@@ -1,21 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / main
-
-# main
-
-## Functions
-
-### \_doNotUseThis()
-
-```ts
-function _doNotUseThis(): never;
-```
-
-Defined in: [packages/utils/src/main.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/main.ts#L1)
-
-#### Returns
-
-`never`

package/docs/mathUtils.md

@@ -1,137 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / mathUtils
-
-# mathUtils
-
-## Functions
-
-### clamp()
-
-```ts
-function clamp(
-   num, 
-   min, 
-   max): number;
-```
-
-Defined in: [packages/utils/src/mathUtils.ts:17](https://github.com/lucasols/utils/blob/main/packages/utils/src/mathUtils.ts#L17)
-
-#### Parameters
-
-##### num
-
-`number`
-
-##### min
-
-`number`
-
-##### max
-
-`number`
-
-#### Returns
-
-`number`
-
-***
-
-### clampMax()
-
-```ts
-function clampMax(value, max): number;
-```
-
-Defined in: [packages/utils/src/mathUtils.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/mathUtils.ts#L1)
-
-#### Parameters
-
-##### value
-
-`number`
-
-##### max
-
-`number`
-
-#### Returns
-
-`number`
-
-***
-
-### clampMin()
-
-```ts
-function clampMin(value, min): number;
-```
-
-Defined in: [packages/utils/src/mathUtils.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/mathUtils.ts#L5)
-
-#### Parameters
-
-##### value
-
-`number`
-
-##### min
-
-`number`
-
-#### Returns
-
-`number`
-
-***
-
-### clampRange()
-
-```ts
-function clampRange(
-   num, 
-   v1, 
-   v2): number;
-```
-
-Defined in: [packages/utils/src/mathUtils.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/mathUtils.ts#L9)
-
-#### Parameters
-
-##### num
-
-`number`
-
-##### v1
-
-`number`
-
-##### v2
-
-`number`
-
-#### Returns
-
-`number`
-
-***
-
-### fixFloatingPointNumber()
-
-```ts
-function fixFloatingPointNumber(value): number;
-```
-
-Defined in: [packages/utils/src/mathUtils.ts:25](https://github.com/lucasols/utils/blob/main/packages/utils/src/mathUtils.ts#L25)
-
-#### Parameters
-
-##### value
-
-`number`
-
-#### Returns
-
-`number`

package/docs/modules.md

@@ -1,58 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-# @ls-stack/utils
-
-## Modules
-
-- [arrayUtils](arrayUtils/README.md)
-- [assertions](assertions/README.md)
-- [asyncQueue](asyncQueue/README.md)
-- [awaitDebounce](awaitDebounce.md)
-- [cache](cache/README.md)
-- [castValues](castValues.md)
-- [concurrentCalls](concurrentCalls/README.md)
-- [consoleFmt](consoleFmt.md)
-- [conversions](conversions.md)
-- [createThrottleController](createThrottleController/README.md)
-- [debounce](debounce.md)
-- [dedent](dedent/README.md)
-- [deepEqual](deepEqual.md)
-- [enhancedMap](enhancedMap.md)
-- [exhaustiveMatch](exhaustiveMatch/README.md)
-- [filterObjectOrArrayKeys](filterObjectOrArrayKeys.md)
-- [getAutoIncrementId](getAutoIncrementId.md)
-- [getCompositeKey](getCompositeKey.md)
-- [getValueStableKey](getValueStableKey.md)
-- [hash](hash.md)
-- [interpolate](interpolate/README.md)
-- [keepPrevIfUnchanged](keepPrevIfUnchanged.md)
-- [levenshtein](levenshtein.md)
-- [main](main.md)
-- [mathUtils](mathUtils.md)
-- [mutationUtils](mutationUtils.md)
-- [objUtils](objUtils.md)
-- [parallelAsyncCalls](parallelAsyncCalls/README.md)
-- [promiseUtils](promiseUtils/README.md)
-- [retryOnError](retryOnError/README.md)
-- [runShellCmd](runShellCmd/README.md)
-- [safeJson](safeJson.md)
-- [saferTyping](saferTyping.md)
-- [serializeXML](serializeXML.md)
-- [shallowEqual](shallowEqual.md)
-- [sleep](sleep.md)
-- [stringUtils](stringUtils/README.md)
-- [testUtils](testUtils.md)
-- [throttle](throttle/README.md)
-- [time](time.md)
-- [timers](timers.md)
-- [tsResult](tsResult/README.md)
-- [typedStrings](typedStrings.md)
-- [typeGuards](typeGuards.md)
-- [typeUtils](typeUtils/README.md)
-- [typeUtils.typesTest](typeUtils.typesTest.md)
-- [typingFnUtils](typingFnUtils/README.md)
-- [typingTestUtils](typingTestUtils.md)
-- [typingUtils](typingUtils.md)
-- [yamlStringify](yamlStringify.md)

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`