@ls-stack/utils 3.39.0 → 3.41.0

package/docs/exhaustiveMatch/README.md

@@ -1,146 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / exhaustiveMatch
-
-# exhaustiveMatch
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Functions
-
-### exhaustiveMatch()
-
-```ts
-function exhaustiveMatch<T>(value): object;
-```
-
-Defined in: [packages/utils/src/exhaustiveMatch.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/exhaustiveMatch.ts#L1)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `string`
-
-#### Parameters
-
-##### value
-
-`T`
-
-#### Returns
-
-##### with()
-
-```ts
-with: <R>(pattern) => R = matchWith;
-```
-
-The pattern can be:
-- a function that returns the result
-- '_nxt' to try the next pattern
-- '_never' to indicate that this pattern should never be matched
-
-###### Type Parameters
-
-###### R
-
-`R`
-
-###### Parameters
-
-###### pattern
-
-[`Pattern`](-internal-.md#pattern)\<`R`\>
-
-###### Returns
-
-`R`
-
-##### withObject()
-
-```ts
-withObject: <R>(pattern) => R;
-```
-
-match with early evaluation of the values
-
-###### Type Parameters
-
-###### R
-
-`R`
-
-###### Parameters
-
-###### pattern
-
-`Record`\<`T`, `R`\>
-
-###### Returns
-
-`R`
-
-***
-
-### exhaustiveMatchObjUnion()
-
-```ts
-function exhaustiveMatchObjUnion<T, D, K>(obj, key): object;
-```
-
-Defined in: [packages/utils/src/exhaustiveMatch.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/exhaustiveMatch.ts#L51)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-##### D
-
-`D` *extends* `string` \| `number` \| `symbol`
-
-##### K
-
-`K` *extends* `string`
-
-#### Parameters
-
-##### obj
-
-`T`
-
-##### key
-
-`D`
-
-#### Returns
-
-`object`
-
-##### with()
-
-```ts
-with: <R>(pattern) => R = withLazy;
-```
-
-###### Type Parameters
-
-###### R
-
-`R`
-
-###### Parameters
-
-###### pattern
-
-[`Pattern`](-internal-.md#pattern-1)\<`R`\>
-
-###### Returns
-
-`R`

package/docs/filterObjectOrArrayKeys.md

@@ -1,109 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / filterObjectOrArrayKeys
-
-# filterObjectOrArrayKeys
-
-## Functions
-
-### filterObjectOrArrayKeys()
-
-```ts
-function filterObjectOrArrayKeys(objOrArray, options): Record<string, any> | Record<string, any>[];
-```
-
-Defined in: [packages/utils/src/filterObjectOrArrayKeys.ts:60](https://github.com/lucasols/utils/blob/main/packages/utils/src/filterObjectOrArrayKeys.ts#L60)
-
-Filters the keys of an object based on the provided patterns.
-
-Filtering patterns in `rejectKeys` and `filterKeys`:
-- `'prop'` - Only root-level properties named 'prop'
-- `'**prop'` - Any property named exactly 'prop' at any level (root or nested)
-- `'*.prop'` - Any nested property named 'prop' at second level (excludes root-level matches)
-- `'test.*.prop'` - Any property named 'prop' at second level of 'test'
-- `'test.*.test.**prop'` - Any property named 'prop' inside of 'test.*.test'
-- `'prop.nested'` - Exact nested property paths like `obj.prop.nested`
-- `'prop.**nested'` - All nested properties inside root `prop` with name `nested`
-- `'prop[0]'` - The first item of the `prop` array
-- `'prop[*]'` - All items of the `prop` array
-- `'prop[0].nested'` - `nested` prop of the first item of the `prop` array
-- `'prop[*].nested'` - `nested` prop of all items of the `prop` array
-- `'prop[*]**nested'` - all `nested` props of all items of the `prop` array
-- `'prop[0-2]'` - The first three items of the `prop` array
-- `'prop[4-*]'` - All items of the `prop` array from the fourth index to the end
-- `'prop[0-2].nested.**prop'` - Combining multiple nested patterns is supported
-- Root array:
-  - `'[0]'` - The first item of the root array
-  - `'[*]'` - All items of the array
-  - `'[0].nested'` - `nested` prop of the first item of the array
-  - `'[*].nested'` - `nested` prop of all items of the array
-  - `'[*]**nested'` - all `nested` props of all items of the array
-  - `'[0-2]'` - The first three items of the array
-  - `'[4-*]'` - All items of the array from the fourth index to the end
-- Pattern expansion with parentheses:
-  - `'prop.test.(prop1|prop2|prop3)'` - Expands to `prop.test.prop1`, `prop.test.prop2`, and `prop.test.prop3`
-  - `'components[*].(table_id|columns|filters[*].value)'` - Expands to `components[*].table_id`, `components[*].columns`, and `components[*].filters[*].value`
-  - `'(users|admins)[*].name'` - Expands to `users[*].name` and `admins[*].name`
-- Array filtering by value:
-  - `'users[%name="John"]'` - Filters the `users` with the `name` property equal to `John`
-  - `'users[%name="John" | "Jane"]'` - Value-level OR using `|` for multiple values of same property
-  - `'users[%name="Alice" || %age=35]'` - Property-level OR using `||` for different properties
-  - `'users[%age=30 && %role="admin"]'` - Property-level AND using `&&` for different properties
-  - Note: Mixing `&&` and `||` in the same filter is not supported - use separate filter patterns instead
-  - `'users[%config.name="John" | "Jane"]'` - Dot notation is supported
-  - `'users[%name*="oh"]'` - Contains operator (*=) - filters users where name contains "oh"
-  - `'users[%name^="Jo"]'` - Starts with operator (^=) - filters users where name starts with "Jo"
-  - `'users[%name$="hn"]'` - Ends with operator ($=) - filters users where name ends with "hn"
-  - `'users[%name!="John"]'` - Not equal operator (!=) - filters users where name is not "John"
-  - `'users[%name!*="admin"]'` - Not contains operator (!*=) - filters users where name doesn't contain "admin"
-  - `'users[i%name="john"]'` - Case-insensitive matching (i% prefix) - matches "John", "JOHN", "john", etc.
-
-#### Parameters
-
-##### objOrArray
-
-The object or array to filter.
-
-`Record`\<`string`, `any`\> | `Record`\<`string`, `any`\>[]
-
-##### options
-
-The options for the filter.
-
-###### filterKeys?
-
-`string` \| `string`[]
-
-The keys to filter.
-
-###### rejectEmptyObjectsInArray?
-
-`boolean` = `true`
-
-Whether to reject empty objects in arrays (default: true).
-
-###### rejectKeys?
-
-`string` \| `string`[]
-
-The keys to reject.
-
-###### sortKeys?
-
-`false` \| `"asc"` \| `"simpleValuesFirst"` \| `"desc"` = `'simpleValuesFirst'`
-
-Sort all keys by a specific order (optional, preserves original order when not specified).
-
-###### sortPatterns?
-
-`string`[]
-
-Sort specific keys by pattern. Use to control the order of specific properties. The same patterns as `filterKeys` are supported.
-
-#### Returns
-
-`Record`\<`string`, `any`\> \| `Record`\<`string`, `any`\>[]
-
-The filtered object or array.

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`