@ls-stack/utils 3.18.0 → 3.19.0

package/docs/hash.md

@@ -0,0 +1,31 @@
+[**@ls-stack/utils**](README.md)
+
+***
+
+[@ls-stack/utils](modules.md) / hash
+
+# hash
+
+## Functions
+
+### murmur2()
+
+```ts
+function murmur2(str): string;
+```
+
+Defined in: [packages/utils/src/hash.ts:8](https://github.com/lucasols/utils/blob/main/packages/utils/src/hash.ts#L8)
+
+#### Parameters
+
+##### str
+
+`string`
+
+The string to hash.
+
+#### Returns
+
+`string`
+
+The hash of the string.

package/docs/interpolate/-internal-.md

@@ -0,0 +1,61 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / [interpolate](README.md) / \<internal\>
+
+# \<internal\>
+
+## Type Aliases
+
+### InterpolateArgs
+
+```ts
+type InterpolateArgs = object;
+```
+
+Defined in: [packages/utils/src/interpolate.ts:29](https://github.com/lucasols/utils/blob/main/packages/utils/src/interpolate.ts#L29)
+
+#### Properties
+
+##### clamp?
+
+```ts
+optional clamp: boolean | "start" | "end";
+```
+
+Defined in: [packages/utils/src/interpolate.ts:33](https://github.com/lucasols/utils/blob/main/packages/utils/src/interpolate.ts#L33)
+
+##### in
+
+```ts
+in: number[];
+```
+
+Defined in: [packages/utils/src/interpolate.ts:31](https://github.com/lucasols/utils/blob/main/packages/utils/src/interpolate.ts#L31)
+
+##### input
+
+```ts
+input: number;
+```
+
+Defined in: [packages/utils/src/interpolate.ts:30](https://github.com/lucasols/utils/blob/main/packages/utils/src/interpolate.ts#L30)
+
+##### out
+
+```ts
+out: number[];
+```
+
+Defined in: [packages/utils/src/interpolate.ts:32](https://github.com/lucasols/utils/blob/main/packages/utils/src/interpolate.ts#L32)
+
+***
+
+### Interval
+
+```ts
+type Interval = [number, number];
+```
+
+Defined in: [packages/utils/src/interpolate.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/interpolate.ts#L4)

package/docs/interpolate/README.md

@@ -0,0 +1,62 @@
+[**@ls-stack/utils**](../README.md)
+
+***
+
+[@ls-stack/utils](../modules.md) / interpolate
+
+# interpolate
+
+## Modules
+
+- [\<internal\>](-internal-.md)
+
+## Functions
+
+### cyclicLerp()
+
+```ts
+function cyclicLerp(
+   input, 
+   __namedParameters, 
+   __namedParameters): number;
+```
+
+Defined in: [packages/utils/src/interpolate.ts:10](https://github.com/lucasols/utils/blob/main/packages/utils/src/interpolate.ts#L10)
+
+#### Parameters
+
+##### input
+
+`number`
+
+##### \_\_namedParameters
+
+[`Interval`](-internal-.md#interval)
+
+##### \_\_namedParameters
+
+[`Interval`](-internal-.md#interval)
+
+#### Returns
+
+`number`
+
+***
+
+### interpolate()
+
+```ts
+function interpolate(__namedParameters): number;
+```
+
+Defined in: [packages/utils/src/interpolate.ts:36](https://github.com/lucasols/utils/blob/main/packages/utils/src/interpolate.ts#L36)
+
+#### Parameters
+
+##### \_\_namedParameters
+
+[`InterpolateArgs`](-internal-.md#interpolateargs)
+
+#### Returns
+
+`number`

package/docs/levenshtein.md

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

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

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

@@ -0,0 +1,52 @@
+[**@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.md)
+- [deepEqual](deepEqual.md)
+- [enhancedMap](enhancedMap.md)
+- [exhaustiveMatch](exhaustiveMatch/README.md)
+- [getAutoIncrementId](getAutoIncrementId.md)
+- [getCompositeKey](getCompositeKey.md)
+- [getValueStableKey](getValueStableKey.md)
+- [hash](hash.md)
+- [interpolate](interpolate/README.md)
+- [levenshtein](levenshtein.md)
+- [main](main.md)
+- [mathUtils](mathUtils.md)
+- [objUtils](objUtils.md)
+- [parallelAsyncCalls](parallelAsyncCalls/README.md)
+- [promiseUtils](promiseUtils/README.md)
+- [retryOnError](retryOnError.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)
+- [typeGuards](typeGuards.md)
+- [typingFnUtils](typingFnUtils/README.md)
+- [typingTestUtils](typingTestUtils.md)
+- [typingUtils](typingUtils.md)
+- [yamlStringify](yamlStringify.md)

package/docs/objUtils.md

@@ -0,0 +1,237 @@
+[**@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:50](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L50)
+
+#### 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:18](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L18)
+
+#### 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:25](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L25)
+
+#### 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:2](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L2)
+
+#### 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:35](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L35)
+
+#### 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:6](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L6)
+
+#### 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:57](https://github.com/lucasols/utils/blob/main/packages/utils/src/objUtils.ts#L57)
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `Record`\<`string`, `unknown`\>
+
+#### Parameters
+
+##### obj
+
+`T`
+
+#### Returns
+
+`T`