@ls-stack/utils 3.40.0 → 3.41.0

package/docs/getAutoIncrementId.md

@@ -1,93 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / getAutoIncrementId
-
-# getAutoIncrementId
-
-## Functions
-
-### getAutoIncrementId()
-
-```ts
-function getAutoIncrementId(): number;
-```
-
-Defined in: [packages/utils/src/getAutoIncrementId.ts:19](https://github.com/lucasols/utils/blob/main/packages/utils/src/getAutoIncrementId.ts#L19)
-
-Returns a unique auto-incrementing number each time it's called.
-This is useful for generating simple unique identifiers within a single session/process.
-
-**Note:** This is not suitable for distributed systems or persistent storage.
-For cryptographically secure or collision-resistant IDs, use `nanoid()` instead.
-
-#### Returns
-
-`number`
-
-A unique incrementing number starting from 1
-
-#### Example
-
-```ts
-const id1 = getAutoIncrementId(); // 1
-const id2 = getAutoIncrementId(); // 2
-const id3 = getAutoIncrementId(); // 3
-```
-
-***
-
-### getLocalAutoIncrementIdGenerator()
-
-```ts
-function getLocalAutoIncrementIdGenerator(options): () => string;
-```
-
-Defined in: [packages/utils/src/getAutoIncrementId.ts:44](https://github.com/lucasols/utils/blob/main/packages/utils/src/getAutoIncrementId.ts#L44)
-
-Creates a local auto-increment ID generator with optional prefix and suffix.
-Each generator maintains its own independent counter starting from 1.
-This is useful when you need multiple independent ID sequences or formatted IDs.
-
-#### Parameters
-
-##### options
-
-Configuration object
-
-###### prefix?
-
-`string`
-
-Optional prefix to prepend to each generated ID
-
-###### suffix?
-
-`string`
-
-Optional suffix to append to each generated ID
-
-#### Returns
-
-A function that generates formatted auto-increment IDs
-
-```ts
-(): string;
-```
-
-##### Returns
-
-`string`
-
-#### Example
-
-```ts
-const userIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'user-' });
-const postIdGen = getLocalAutoIncrementIdGenerator({ prefix: 'post-', suffix: '-draft' });
-
-console.log(userIdGen()); // "user-1"
-console.log(userIdGen()); // "user-2"
-console.log(postIdGen()); // "post-1-draft"
-console.log(postIdGen()); // "post-2-draft"
-```

package/docs/getCompositeKey.md

@@ -1,39 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / getCompositeKey
-
-# getCompositeKey
-
-## Functions
-
-### getCompositeKey()
-
-```ts
-function getCompositeKey(input, maxSortingDepth): string;
-```
-
-Defined in: [packages/utils/src/getCompositeKey.ts:10](https://github.com/lucasols/utils/blob/main/packages/utils/src/getCompositeKey.ts#L10)
-
-Returns a stable key for the input value.
-
-#### Parameters
-
-##### input
-
-`unknown`
-
-The value to get a stable key for.
-
-##### maxSortingDepth
-
-`number` = `3`
-
-The maximum depth to sort the input value. Default is 3.
-
-#### Returns
-
-`string`
-
-A stable key for the input value.

package/docs/getValueStableKey.md

@@ -1,57 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / getValueStableKey
-
-# getValueStableKey
-
-## Variables
-
-### ~~getValueStableKey()~~
-
-```ts
-const getValueStableKey: (input, maxSortingDepth) => string = getCompositeKey;
-```
-
-Defined in: [packages/utils/src/getValueStableKey.ts:12](https://github.com/lucasols/utils/blob/main/packages/utils/src/getValueStableKey.ts#L12)
-
-Returns a stable key for the input value.
-
-Returns a stable key for the input value.
-
-#### Parameters
-
-##### input
-
-`unknown`
-
-The value to get a stable key for.
-
-##### maxSortingDepth
-
-`number` = `3`
-
-The maximum depth to sort the input value. Default is 3.
-
-#### Returns
-
-`string`
-
-A stable key for the input value.
-
-#### Param
-
-The value to get a stable key for.
-
-#### Param
-
-The maximum depth to sort the input value. Default is 3.
-
-#### Returns
-
-A stable key for the input value.
-
-#### Deprecated
-
-Use `getCompositeKey` from `@ls-stack/utils/getCompositeKey` instead.

package/docs/hash.md

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

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

@@ -1,62 +0,0 @@
-[**@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/keepPrevIfUnchanged.md

@@ -1,43 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / keepPrevIfUnchanged
-
-# keepPrevIfUnchanged
-
-## Functions
-
-### keepPrevIfUnchanged()
-
-```ts
-function keepPrevIfUnchanged<T>(__namedParameters): T;
-```
-
-Defined in: [packages/utils/src/keepPrevIfUnchanged.ts:3](https://github.com/lucasols/utils/blob/main/packages/utils/src/keepPrevIfUnchanged.ts#L3)
-
-#### Type Parameters
-
-##### T
-
-`T`
-
-#### Parameters
-
-##### \_\_namedParameters
-
-###### equalityFn?
-
-(`foo`, `bar`) => `boolean` = `deepEqual`
-
-###### newValue
-
-`T`
-
-###### prev
-
-`T`
-
-#### Returns
-
-`T`

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)