@ls-stack/utils 3.17.1 → 3.19.0

package/docs/debounce.md

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

@@ -0,0 +1,117 @@
+[**@ls-stack/utils**](README.md)
+
+***
+
+[@ls-stack/utils](modules.md) / dedent
+
+# dedent
+
+## Interfaces
+
+### Dedent()
+
+Defined in: [packages/utils/src/dedent.ts:6](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L6)
+
+#### Call Signature
+
+```ts
+Dedent(literals): string;
+```
+
+Defined in: [packages/utils/src/dedent.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L7)
+
+##### Parameters
+
+###### literals
+
+`string`
+
+##### Returns
+
+`string`
+
+#### Call Signature
+
+```ts
+Dedent(strings, ...values): string;
+```
+
+Defined in: [packages/utils/src/dedent.ts:8](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L8)
+
+##### Parameters
+
+###### strings
+
+`TemplateStringsArray`
+
+###### values
+
+...`unknown`[]
+
+##### Returns
+
+`string`
+
+#### Properties
+
+##### withOptions
+
+```ts
+withOptions: CreateDedent;
+```
+
+Defined in: [packages/utils/src/dedent.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L9)
+
+***
+
+### DedentOptions
+
+Defined in: [packages/utils/src/dedent.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L1)
+
+#### Properties
+
+##### escapeSpecialCharacters?
+
+```ts
+optional escapeSpecialCharacters: boolean;
+```
+
+Defined in: [packages/utils/src/dedent.ts:2](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L2)
+
+##### trimWhitespace?
+
+```ts
+optional trimWhitespace: boolean;
+```
+
+Defined in: [packages/utils/src/dedent.ts:3](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L3)
+
+## Type Aliases
+
+### CreateDedent()
+
+```ts
+type CreateDedent = (options) => Dedent;
+```
+
+Defined in: [packages/utils/src/dedent.ts:12](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L12)
+
+#### Parameters
+
+##### options
+
+[`DedentOptions`](#dedentoptions)
+
+#### Returns
+
+[`Dedent`](#dedent)
+
+## Variables
+
+### dedent
+
+```ts
+const dedent: Dedent;
+```
+
+Defined in: [packages/utils/src/dedent.ts:14](https://github.com/lucasols/utils/blob/main/packages/utils/src/dedent.ts#L14)

package/docs/deepEqual.md

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