@ls-stack/utils 3.40.0 → 3.42.0

package/docs/debounce.md

@@ -1,188 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / debounce
-
-# debounce
-
-## Interfaces
-
-### DebouncedFunc()\<T\>
-
-Defined in: [packages/utils/src/debounce.ts:16](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L16)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* (...`args`) => `void`
-
-```ts
-DebouncedFunc(...args): undefined | ReturnType<T>;
-```
-
-Defined in: [packages/utils/src/debounce.ts:26](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L26)
-
-Call the original function, but applying the debounce rules.
-
-If the debounced function can be run immediately, this calls it and returns its return
-value.
-
-Otherwise, it returns the return value of the last invocation, or undefined if the debounced
-function was not invoked yet.
-
-#### Parameters
-
-##### args
-
-...`Parameters`\<`T`\>
-
-#### Returns
-
-`undefined` \| `ReturnType`\<`T`\>
-
-#### Properties
-
-##### cancel()
-
-```ts
-cancel: () => void;
-```
-
-Defined in: [packages/utils/src/debounce.ts:31](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L31)
-
-Throw away any pending invocation of the debounced function.
-
-###### Returns
-
-`void`
-
-##### flush()
-
-```ts
-flush: () => undefined | ReturnType<T>;
-```
-
-Defined in: [packages/utils/src/debounce.ts:40](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L40)
-
-If there is a pending invocation of the debounced function, invoke it immediately and return
-its return value.
-
-Otherwise, return the value from the last invocation, or undefined if the debounced function
-was never invoked.
-
-###### Returns
-
-`undefined` \| `ReturnType`\<`T`\>
-
-## Type Aliases
-
-### DebounceOptions
-
-```ts
-type DebounceOptions = object;
-```
-
-Defined in: [packages/utils/src/debounce.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L1)
-
-#### Properties
-
-##### leading?
-
-```ts
-optional leading: boolean;
-```
-
-Defined in: [packages/utils/src/debounce.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L5)
-
-###### See
-
-_.leading
-
-##### maxWait?
-
-```ts
-optional maxWait: number;
-```
-
-Defined in: [packages/utils/src/debounce.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L9)
-
-###### See
-
-_.maxWait
-
-##### trailing?
-
-```ts
-optional trailing: boolean;
-```
-
-Defined in: [packages/utils/src/debounce.ts:13](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L13)
-
-###### See
-
-_.trailing
-
-## Functions
-
-### debounce()
-
-```ts
-function debounce<T>(
-   func, 
-   wait, 
-options?): DebouncedFunc<T>;
-```
-
-Defined in: [packages/utils/src/debounce.ts:44](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L44)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* (...`args`) => `void`
-
-#### Parameters
-
-##### func
-
-`T`
-
-##### wait
-
-`number`
-
-##### options?
-
-[`DebounceOptions`](#debounceoptions)
-
-#### Returns
-
-[`DebouncedFunc`](#debouncedfunc)\<`T`\>
-
-***
-
-### isDebouncedFn()
-
-```ts
-function isDebouncedFn<T>(fn): fn is T & { cancel: () => void; flush: () => undefined | ReturnType<T> };
-```
-
-Defined in: [packages/utils/src/debounce.ts:176](https://github.com/lucasols/utils/blob/main/packages/utils/src/debounce.ts#L176)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* (...`args`) => `void`
-
-#### Parameters
-
-##### fn
-
-`T`
-
-#### Returns
-
-fn is T & \{ cancel: () =\> void; flush: () =\> undefined \| ReturnType\<T\> \}

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`