@ls-stack/utils 3.39.0 → 3.41.0

package/docs/dedent/-internal-.md

@@ -1,17 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / [dedent](README.md) / \<internal\>
-
-# \<internal\>
-
-## Type Aliases
-
-### InterpolationValue
-
-```ts
-type InterpolationValue = string | number | boolean | null | undefined;
-```
-
-Defined in: [packages/utils/src/dedent.ts:30](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L30)

package/docs/dedent/README.md

@@ -1,204 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / dedent
-
-# dedent
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Interfaces
-
-### Dedent()
-
-Defined in: [packages/utils/src/dedent.ts:35](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L35)
-
-Dedent function interface that can be used both as a template tag and a regular function
-
-#### Call Signature
-
-```ts
-Dedent(literals): string;
-```
-
-Defined in: [packages/utils/src/dedent.ts:39](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L39)
-
-Dedent function interface that can be used both as a template tag and a regular function
-
-##### Parameters
-
-###### literals
-
-`string`
-
-##### Returns
-
-`string`
-
-#### Call Signature
-
-```ts
-Dedent(strings, ...values): string;
-```
-
-Defined in: [packages/utils/src/dedent.ts:43](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L43)
-
-Dedent function interface that can be used both as a template tag and a regular function
-
-##### Parameters
-
-###### strings
-
-`TemplateStringsArray`
-
-###### values
-
-...[`InterpolationValue`](-internal-.md#interpolationvalue)[]
-
-##### Returns
-
-`string`
-
-#### Properties
-
-##### withOptions
-
-```ts
-withOptions: CreateDedent;
-```
-
-Defined in: [packages/utils/src/dedent.ts:47](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L47)
-
-Create a new dedent function with custom options
-
-***
-
-### DedentOptions
-
-Defined in: [packages/utils/src/dedent.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L4)
-
-Configuration options for the dedent function behavior
-
-#### Properties
-
-##### escapeSpecialCharacters?
-
-```ts
-optional escapeSpecialCharacters: boolean;
-```
-
-Defined in: [packages/utils/src/dedent.ts:10](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L10)
-
-Whether to process escape sequences like \n, `, \$, and {
-When true, allows using escaped characters in template literals
-
-###### Default
-
-```ts
-true for template literals, false for plain strings
-```
-
-##### identInterpolations?
-
-```ts
-optional identInterpolations: boolean;
-```
-
-Defined in: [packages/utils/src/dedent.ts:21](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L21)
-
-Whether to preserve relative indentation of interpolated multi-line values
-When true, multi-line interpolations are re-indented to match the surrounding context
-
-###### Default
-
-```ts
-true
-```
-
-##### showNullishOrFalseValues?
-
-```ts
-optional showNullishOrFalseValues: boolean;
-```
-
-Defined in: [packages/utils/src/dedent.ts:27](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L27)
-
-Whether to display nullish or false values (false, null, undefined) in interpolations
-When false, nullish or false values are skipped entirely
-
-###### Default
-
-```ts
-false
-```
-
-##### trimWhitespace?
-
-```ts
-optional trimWhitespace: boolean;
-```
-
-Defined in: [packages/utils/src/dedent.ts:15](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L15)
-
-Whether to trim leading and trailing whitespace from the final result
-
-###### Default
-
-```ts
-true
-```
-
-## Type Aliases
-
-### CreateDedent()
-
-```ts
-type CreateDedent = (options) => Dedent;
-```
-
-Defined in: [packages/utils/src/dedent.ts:53](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L53)
-
-Factory function type for creating dedent functions with custom options
-
-#### Parameters
-
-##### options
-
-[`DedentOptions`](#dedentoptions)
-
-#### Returns
-
-[`Dedent`](#dedent)
-
-## Variables
-
-### dedent
-
-```ts
-const dedent: Dedent;
-```
-
-Defined in: [packages/utils/src/dedent.ts:75](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L75)
-
-Remove common leading indentation from multi-line strings while preserving relative indentation.
-Can be used as a tagged template literal or called with a plain string.
-
-By default, it will dedent interpolated multi-line strings to match the surrounding context.
-And it will not show falsy values.
-
-#### Example
-
-```typescript
-const text = dedent`
-  function hello() {
-    console.log('world');
-  }
-`;
-// Result:
-"function hello() {
-  console.log('world');
-}"
-```

package/docs/deepEqual.md

@@ -1,94 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / deepEqual
-
-# deepEqual
-
-## Functions
-
-### deepEqual()
-
-```ts
-function deepEqual(
-   foo, 
-   bar, 
-   maxDepth): boolean;
-```
-
-Defined in: [packages/utils/src/deepEqual.ts:30](https://github.com/lucasols/utils/blob/main/packages/utils/src/deepEqual.ts#L30)
-
-Deep equality comparison between two values
-
-#### Parameters
-
-##### foo
-
-`any`
-
-First value to compare
-
-##### bar
-
-`any`
-
-Second value to compare
-
-##### maxDepth
-
-`number` = `20`
-
-Maximum comparison depth (default: 20)
-
-#### Returns
-
-`boolean`
-
-True if values are deeply equal, false otherwise
-
-#### Example
-
-```ts
-deepEqual({a: 1}, {a: 1}) // true
-deepEqual({a: 1}, {a: 2}) // false
-deepEqual([1, {b: 2}], [1, {b: 2}]) // true
-deepEqual(new Map([['a', 1]]), new Map([['a', 1]])) // true
-deepEqual(new Set([1, 2]), new Set([1, 2])) // true
-```
-
-***
-
-### deepEqualWithMaxDepth()
-
-```ts
-function deepEqualWithMaxDepth(maxDepth): (foo, bar) => boolean;
-```
-
-Defined in: [packages/utils/src/deepEqual.ts:94](https://github.com/lucasols/utils/blob/main/packages/utils/src/deepEqual.ts#L94)
-
-#### Parameters
-
-##### maxDepth
-
-`number`
-
-#### Returns
-
-```ts
-(foo, bar): boolean;
-```
-
-##### Parameters
-
-###### foo
-
-`any`
-
-###### bar
-
-`any`
-
-##### Returns
-
-`boolean`

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`