@ls-stack/utils 3.40.0 → 3.42.0

package/docs/testUtils.md

@@ -1,382 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / testUtils
-
-# testUtils
-
-## Functions
-
-### compactSnapshot()
-
-```ts
-function compactSnapshot(value, options): string;
-```
-
-Defined in: [packages/utils/src/testUtils.ts:364](https://github.com/lucasols/utils/blob/main/packages/utils/src/testUtils.ts#L364)
-
-Produces a more compact and readable snapshot of a value using yaml.
-By default booleans are shown as `✅` and `❌`, use `showBooleansAs` to disable/configure this.
-
-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
-- Expanding the patterns with parentheses:
-  - `'prop.test.(prop1|prop2|prop3.prop4)'` - Will produce `prop.test.prop1`, `prop.test.prop2`, and `prop.test.prop3.prop4`
-- Array filtering by value:
-  - `'users[%name="John"]'` - Filters the `users` with the `name` property equal to `John`
-  - `'users[%name="John" | "Jane"]'` - Filters the `users` with the `name` property equal to `John` or `Jane`
-  - `'users[%name="John" | "Jane" && %age=20]'` - AND and OR are supported by using `&&` and `||`, nesting logical operators is not supported yet
-  - `'users[%config.name="John" | "Jane"]'` - Dot notation is supported
-
-Check more supported patterns in [filterObjectOrArrayKeys](filterObjectOrArrayKeys.md#filterobjectorarraykeys) docs.
-
-#### Parameters
-
-##### value
-
-`unknown`
-
-The value to snapshot.
-
-##### options
-
-[`YamlStringifyOptions`](yamlStringify.md#yamlstringifyoptions) & `object` = `{}`
-
-The options for the snapshot.
-
-#### Returns
-
-`string`
-
-The compact snapshot of the value.
-
-***
-
-### createLoggerStore()
-
-```ts
-function createLoggerStore(__namedParameters): object;
-```
-
-Defined in: [packages/utils/src/testUtils.ts:11](https://github.com/lucasols/utils/blob/main/packages/utils/src/testUtils.ts#L11)
-
-#### Parameters
-
-##### \_\_namedParameters
-
-###### arrays?
-
-  \| `"length"`
-  \| `"all"`
-  \| `"firstAndLast"`
-  \| \{
-  `firstNItems`: `number`;
-\} = `...`
-
-###### changesOnly?
-
-`boolean` = `false`
-
-###### filterKeys?
-
-`string`[]
-
-###### fromLastSnapshot?
-
-`boolean` = `false`
-
-###### maxLineLengthBeforeSplit?
-
-`number` = `80`
-
-###### rejectKeys?
-
-`string`[]
-
-###### splitLongLines?
-
-`true` = `true`
-
-###### useEmojiForBooleans?
-
-`boolean` = `true`
-
-#### Returns
-
-`object`
-
-##### add()
-
-```ts
-add: (render) => void;
-```
-
-###### Parameters
-
-###### render
-
-`Record`\<`string`, `unknown`\> | readonly `Record`\<`string`, `unknown`\>[]
-
-###### Returns
-
-`void`
-
-##### addMark()
-
-```ts
-addMark: (label) => void;
-```
-
-###### Parameters
-
-###### label
-
-`string`
-
-###### Returns
-
-`void`
-
-##### getSnapshot()
-
-```ts
-getSnapshot: (__namedParameters) => string;
-```
-
-###### Parameters
-
-###### \_\_namedParameters
-
-###### arrays?
-
-  \| `"length"`
-  \| `"all"`
-  \| `"firstAndLast"`
-  \| \{
-  `firstNItems`: `number`;
-\} = `defaultArrays`
-
-###### changesOnly?
-
-`boolean` = `defaultChangesOnly`
-
-###### filterKeys?
-
-`string`[] = `defaultFilterKeys`
-
-###### fromLastSnapshot?
-
-`boolean` = `defaultFromLastSnapshot`
-
-###### includeLastSnapshotEndMark?
-
-`boolean` = `true`
-
-###### maxLineLengthBeforeSplit?
-
-`number` = `defaultMaxLineLengthBeforeSplit`
-
-###### rejectKeys?
-
-`string`[] = `defaultRejectKeys`
-
-###### splitLongLines?
-
-`boolean` = `defaultSplitLongLines`
-
-###### useEmojiForBooleans?
-
-`boolean` = `defaultUseEmojiForBooleans`
-
-###### Returns
-
-`string`
-
-##### logsCount()
-
-```ts
-logsCount: () => number;
-```
-
-###### Returns
-
-`number`
-
-##### reset()
-
-```ts
-reset: (keepLastRender) => void;
-```
-
-###### Parameters
-
-###### keepLastRender
-
-`boolean` = `false`
-
-###### Returns
-
-`void`
-
-##### waitNextLog()
-
-```ts
-waitNextLog: (timeout) => Promise<void>;
-```
-
-###### Parameters
-
-###### timeout
-
-`number` = `50`
-
-###### Returns
-
-`Promise`\<`void`\>
-
-##### changesSnapshot
-
-###### Get Signature
-
-```ts
-get changesSnapshot(): string;
-```
-
-###### Returns
-
-`string`
-
-##### rendersTime
-
-###### Get Signature
-
-```ts
-get rendersTime(): number[];
-```
-
-###### Returns
-
-`number`[]
-
-##### snapshot
-
-###### Get Signature
-
-```ts
-get snapshot(): string;
-```
-
-###### Returns
-
-`string`
-
-##### snapshotFromLast
-
-###### Get Signature
-
-```ts
-get snapshotFromLast(): string;
-```
-
-###### Returns
-
-`string`
-
-***
-
-### getResultFn()
-
-```ts
-function getResultFn<T>(fnGetter, wrapper?): T;
-```
-
-Defined in: [packages/utils/src/testUtils.ts:277](https://github.com/lucasols/utils/blob/main/packages/utils/src/testUtils.ts#L277)
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* (...`args`) => `any`
-
-#### Parameters
-
-##### fnGetter
-
-() => `T`
-
-##### wrapper?
-
-(...`args`) => `any`
-
-#### Returns
-
-`T`
-
-***
-
-### waitController()
-
-```ts
-function waitController(): object;
-```
-
-Defined in: [packages/utils/src/testUtils.ts:292](https://github.com/lucasols/utils/blob/main/packages/utils/src/testUtils.ts#L292)
-
-#### Returns
-
-`object`
-
-##### stopWaiting()
-
-```ts
-stopWaiting: () => void;
-```
-
-###### Returns
-
-`void`
-
-##### stopWaitingAfter()
-
-```ts
-stopWaitingAfter: (ms) => void;
-```
-
-###### Parameters
-
-###### ms
-
-`number`
-
-###### Returns
-
-`void`
-
-##### wait
-
-```ts
-wait: Promise<void>;
-```

package/docs/throttle/-internal-.md

@@ -1,47 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / [throttle](README.md) / \<internal\>
-
-# \<internal\>
-
-## Interfaces
-
-### ThrottleSettings
-
-Defined in: [packages/utils/src/throttle.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/throttle.ts#L7)
-
-#### Properties
-
-##### leading?
-
-```ts
-optional leading: boolean;
-```
-
-Defined in: [packages/utils/src/throttle.ts:12](https://github.com/lucasols/utils/blob/main/packages/utils/src/throttle.ts#L12)
-
-Specify invoking on the leading edge of the timeout.
-
-###### Default
-
-```ts
-true
-```
-
-##### trailing?
-
-```ts
-optional trailing: boolean;
-```
-
-Defined in: [packages/utils/src/throttle.ts:17](https://github.com/lucasols/utils/blob/main/packages/utils/src/throttle.ts#L17)
-
-Specify invoking on the trailing edge of the timeout.
-
-###### Default
-
-```ts
-true
-```

package/docs/throttle/README.md

@@ -1,178 +0,0 @@
-[**@ls-stack/utils**](../README.md)
-
-***
-
-[@ls-stack/utils](../modules.md) / throttle
-
-# throttle
-
-## Modules
-
-- [\<internal\>](-internal-.md)
-
-## Functions
-
-### createThrottledFunctionFactory()
-
-```ts
-function createThrottledFunctionFactory<T, R>(
-   wait, 
-   callback, 
-   options?): object;
-```
-
-Defined in: [packages/utils/src/throttle.ts:104](https://github.com/lucasols/utils/blob/main/packages/utils/src/throttle.ts#L104)
-
-Creates a factory for throttled functions that caches throttled instances based on function arguments.
-Each unique set of arguments gets its own throttled function instance, allowing for fine-grained
-throttling control per argument combination.
-
-This is useful when you want to throttle calls to the same function but with different parameters
-independently. For example, throttling API calls per user ID or throttling UI updates per component.
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `undefined` \| `null` \| `string` \| `number` \| `boolean`
-
-The type of arguments the callback function accepts
-
-##### R
-
-`R`
-
-The return type of the callback function
-
-#### Parameters
-
-##### wait
-
-`number`
-
-The number of milliseconds to throttle invocations to
-
-##### callback
-
-(...`args`) => `R`
-
-The function to throttle
-
-##### options?
-
-[`ThrottleSettings`](-internal-.md#throttlesettings)
-
-The throttle options (leading/trailing behavior)
-
-#### Returns
-
-`object`
-
-An object with a `call` method that accepts the callback arguments
-
-##### call()
-
-```ts
-call: (...args) => undefined | R;
-```
-
-###### Parameters
-
-###### args
-
-...`T`[]
-
-###### Returns
-
-`undefined` \| `R`
-
-#### Examples
-
-```ts
-const apiThrottle = createThrottledFunctionFactory(
-  1000,
-  (userId: string, action: string) => callAPI(userId, action)
-);
-
-// Each user gets their own throttled instance
-apiThrottle.call('user1', 'update'); // Executes immediately
-apiThrottle.call('user2', 'update'); // Executes immediately (different user)
-apiThrottle.call('user1', 'update'); // Throttled (same user)
-```
-
-```ts
-// Throttle UI updates per component
-const updateThrottle = createThrottledFunctionFactory(
-  100,
-  (componentId: string, data: any) => updateComponent(componentId, data)
-);
-```
-
-***
-
-### throttle()
-
-```ts
-function throttle<T>(
-   func, 
-   wait, 
-options?): DebouncedFunc<T>;
-```
-
-Defined in: [packages/utils/src/throttle.ts:51](https://github.com/lucasols/utils/blob/main/packages/utils/src/throttle.ts#L51)
-
-Creates a throttled function that only invokes the provided function at most once per every `wait` milliseconds.
-The throttled function comes with a `cancel` method to cancel delayed invocations and a `flush` method to immediately invoke them.
-
-Throttling is useful for rate-limiting events that fire frequently, like scroll or resize handlers.
-Unlike debouncing, throttling guarantees the function is called at regular intervals.
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* [`__LEGIT_ANY_FUNCTION__`](../saferTyping.md#__legit_any_function__)
-
-The type of the function to throttle
-
-#### Parameters
-
-##### func
-
-`T`
-
-The function to throttle
-
-##### wait
-
-`number`
-
-The number of milliseconds to throttle invocations to
-
-##### options?
-
-[`ThrottleSettings`](-internal-.md#throttlesettings)
-
-The options object
-
-#### Returns
-
-[`DebouncedFunc`](../debounce.md#debouncedfunc)\<`T`\>
-
-Returns the new throttled function
-
-#### Examples
-
-```ts
-const throttledSave = throttle(saveData, 1000);
-
-// Will only call saveData at most once per second
-throttledSave();
-throttledSave();
-throttledSave();
-```
-
-```ts
-// Only invoke on trailing edge
-const throttledHandler = throttle(handleScroll, 100, { leading: false });
-```