@ls-stack/utils 3.40.0 → 3.41.0

package/docs/enhancedMap.md

@@ -1,358 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / enhancedMap
-
-# enhancedMap
-
-## Classes
-
-### EnhancedMap\<K, V\>
-
-Defined in: [packages/utils/src/enhancedMap.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L5)
-
-#### Extends
-
-- `Map`\<`K`, `V`\>
-
-#### Type Parameters
-
-##### K
-
-`K`
-
-##### V
-
-`V`
-
-#### Constructors
-
-##### Constructor
-
-```ts
-new EnhancedMap<K, V>(entries?): EnhancedMap<K, V>;
-```
-
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:50
-
-###### Parameters
-
-###### entries?
-
-`null` | readonly readonly \[`K`, `V`\][]
-
-###### Returns
-
-[`EnhancedMap`](#enhancedmap)\<`K`, `V`\>
-
-###### Inherited from
-
-```ts
-Map<K, V>.constructor
-```
-
-##### Constructor
-
-```ts
-new EnhancedMap<K, V>(iterable?): EnhancedMap<K, V>;
-```
-
-Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2015.collection.d.ts:49
-
-###### Parameters
-
-###### iterable?
-
-`null` | `Iterable`\<readonly \[`K`, `V`\], `any`, `any`\>
-
-###### Returns
-
-[`EnhancedMap`](#enhancedmap)\<`K`, `V`\>
-
-###### Inherited from
-
-```ts
-Map<K, V>.constructor
-```
-
-#### Methods
-
-##### find()
-
-```ts
-find(predicate): 
-  | undefined
-  | {
-  key: K;
-  value: V;
-};
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:6](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L6)
-
-###### Parameters
-
-###### predicate
-
-(`value`, `key`) => `boolean`
-
-###### Returns
-
-  \| `undefined`
-  \| \{
-  `key`: `K`;
-  `value`: `V`;
-\}
-
-##### getOrInsert()
-
-```ts
-getOrInsert(key, fallback): V;
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:44](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L44)
-
-###### Parameters
-
-###### key
-
-`K`
-
-###### fallback
-
-() => `V`
-
-###### Returns
-
-`V`
-
-##### getOrThrow()
-
-```ts
-getOrThrow(key): V;
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:34](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L34)
-
-###### Parameters
-
-###### key
-
-`K`
-
-###### Returns
-
-`V`
-
-##### setMultiple()
-
-###### Call Signature
-
-```ts
-setMultiple(values): this;
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:18](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L18)
-
-###### Parameters
-
-###### values
-
-`Record`\<`K` & `string`, `V`\>
-
-###### Returns
-
-`this`
-
-###### Call Signature
-
-```ts
-setMultiple(...values): this;
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:19](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L19)
-
-###### Parameters
-
-###### values
-
-...\[`K`, `V`\][]
-
-###### Returns
-
-`this`
-
-##### toFilteredValues()
-
-```ts
-toFilteredValues(predicate): V[];
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:52](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L52)
-
-###### Parameters
-
-###### predicate
-
-(`value`, `key`) => `boolean`
-
-###### Returns
-
-`V`[]
-
-##### toKeys()
-
-```ts
-toKeys(): K[];
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:104](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L104)
-
-###### Returns
-
-`K`[]
-
-##### toMap()
-
-```ts
-toMap<T>(mapFunction): T[];
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:64](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L64)
-
-###### Type Parameters
-
-###### T
-
-`T`
-
-###### Parameters
-
-###### mapFunction
-
-(`value`, `key`, `reject`) => *typeof* [`enhancedMapReject`](#enhancedmapreject) \| `T`
-
-###### Returns
-
-`T`[]
-
-##### toObjMap()
-
-```ts
-toObjMap<ObjKey, ObjValue>(mapFunction): Record<ObjKey, ObjValue>;
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:84](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L84)
-
-###### Type Parameters
-
-###### ObjKey
-
-`ObjKey` *extends* `PropertyKey`
-
-###### ObjValue
-
-`ObjValue`
-
-###### Parameters
-
-###### mapFunction
-
-(`value`, `key`) => `false` \| \[`ObjKey`, `ObjValue`\]
-
-###### Returns
-
-`Record`\<`ObjKey`, `ObjValue`\>
-
-##### toValues()
-
-```ts
-toValues(): V[];
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:100](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L100)
-
-###### Returns
-
-`V`[]
-
-##### from()
-
-###### Call Signature
-
-```ts
-static from<T, K>(array, key): EnhancedMap<T[K], T>;
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:108](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L108)
-
-###### Type Parameters
-
-###### T
-
-`T` *extends* `Record`\<`string`, `unknown`\>
-
-###### K
-
-`K` *extends* `string` \| `number` \| `symbol`
-
-###### Parameters
-
-###### array
-
-`undefined` | `null` | `Iterable`\<`T`, `any`, `any`\> | `T`[]
-
-###### key
-
-`K`
-
-###### Returns
-
-[`EnhancedMap`](#enhancedmap)\<`T`\[`K`\], `T`\>
-
-###### Call Signature
-
-```ts
-static from<T, K, V>(array, mapFunction): EnhancedMap<K, V>;
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:112](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L112)
-
-###### Type Parameters
-
-###### T
-
-`T`
-
-###### K
-
-`K`
-
-###### V
-
-`V`
-
-###### Parameters
-
-###### array
-
-`undefined` | `null` | `T`[] | `Iterable`\<`T`, `any`, `any`\>
-
-###### mapFunction
-
-(`item`) => `false` \| \[`K`, `V`\]
-
-###### Returns
-
-[`EnhancedMap`](#enhancedmap)\<`K`, `V`\>
-
-## Variables
-
-### enhancedMapReject
-
-```ts
-const enhancedMapReject: typeof enhancedMapReject;
-```
-
-Defined in: [packages/utils/src/enhancedMap.ts:3](https://github.com/lucasols/utils/blob/main/packages/utils/src/enhancedMap.ts#L3)

package/docs/exhaustiveMatch/-internal-.md

@@ -1,39 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / [exhaustiveMatch](README.md) / \<internal\>
-
-# \<internal\>
-
-## Type Aliases
-
-### Pattern\<R\>
-
-```ts
-type Pattern<R> = { [K in T]: (() => R) | "_nxt" | "_never" };
-```
-
-Defined in: [packages/utils/src/exhaustiveMatch.ts:2](https://github.com/lucasols/utils/blob/main/packages/utils/src/exhaustiveMatch.ts#L2)
-
-#### Type Parameters
-
-##### R
-
-`R`
-
-***
-
-### Pattern\<R\>
-
-```ts
-type Pattern<R> = { [P in K]: ((props: Extract<T, Record<D, P>>) => R) | "_never" };
-```
-
-Defined in: [packages/utils/src/exhaustiveMatch.ts:56](https://github.com/lucasols/utils/blob/main/packages/utils/src/exhaustiveMatch.ts#L56)
-
-#### Type Parameters
-
-##### R
-
-`R`

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.