@ls-stack/utils 3.40.0 → 3.42.0

package/docs/time.md

@@ -1,274 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / time
-
-# time
-
-## Type Aliases
-
-### DurationObj
-
-```ts
-type DurationObj = object;
-```
-
-Defined in: [packages/utils/src/time.ts:111](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L111)
-
-#### Properties
-
-##### days?
-
-```ts
-optional days: number;
-```
-
-Defined in: [packages/utils/src/time.ts:116](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L116)
-
-##### hours?
-
-```ts
-optional hours: number;
-```
-
-Defined in: [packages/utils/src/time.ts:115](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L115)
-
-##### minutes?
-
-```ts
-optional minutes: number;
-```
-
-Defined in: [packages/utils/src/time.ts:114](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L114)
-
-##### ms?
-
-```ts
-optional ms: number;
-```
-
-Defined in: [packages/utils/src/time.ts:112](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L112)
-
-##### seconds?
-
-```ts
-optional seconds: number;
-```
-
-Defined in: [packages/utils/src/time.ts:113](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L113)
-
-## Variables
-
-### DAY\_AS\_MS
-
-```ts
-const DAY_AS_MS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:6](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L6)
-
-***
-
-### DAY\_AS\_SECS
-
-```ts
-const DAY_AS_SECS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:12](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L12)
-
-***
-
-### HOUR\_AS\_MS
-
-```ts
-const HOUR_AS_MS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:5](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L5)
-
-***
-
-### HOUR\_AS\_SECS
-
-```ts
-const HOUR_AS_SECS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:11](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L11)
-
-***
-
-### MINUTE\_AS\_MS
-
-```ts
-const MINUTE_AS_MS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:4](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L4)
-
-***
-
-### MONTH\_AS\_MS
-
-```ts
-const MONTH_AS_MS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:8](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L8)
-
-***
-
-### MONTH\_AS\_SECS
-
-```ts
-const MONTH_AS_SECS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:14](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L14)
-
-***
-
-### WEEK\_AS\_MS
-
-```ts
-const WEEK_AS_MS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:7](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L7)
-
-***
-
-### WEEK\_AS\_SECS
-
-```ts
-const WEEK_AS_SECS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:13](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L13)
-
-***
-
-### YEAR\_AS\_MS
-
-```ts
-const YEAR_AS_MS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:9](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L9)
-
-***
-
-### YEAR\_AS\_SECS
-
-```ts
-const YEAR_AS_SECS: number;
-```
-
-Defined in: [packages/utils/src/time.ts:15](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L15)
-
-## Functions
-
-### dateStringOrNullToUnixMs()
-
-```ts
-function dateStringOrNullToUnixMs(isoString): null | number;
-```
-
-Defined in: [packages/utils/src/time.ts:17](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L17)
-
-#### Parameters
-
-##### isoString
-
-`undefined` | `null` | `string`
-
-#### Returns
-
-`null` \| `number`
-
-***
-
-### durationObjToMs()
-
-```ts
-function durationObjToMs(durationObj): number;
-```
-
-Defined in: [packages/utils/src/time.ts:119](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L119)
-
-#### Parameters
-
-##### durationObj
-
-[`DurationObj`](#durationobj)
-
-#### Returns
-
-`number`
-
-***
-
-### getUnixSeconds()
-
-```ts
-function getUnixSeconds(): number;
-```
-
-Defined in: [packages/utils/src/time.ts:107](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L107)
-
-#### Returns
-
-`number`
-
-***
-
-### msToTimeString()
-
-```ts
-function msToTimeString(
-   ms, 
-   format, 
-   hoursMinLength): string;
-```
-
-Defined in: [packages/utils/src/time.ts:29](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L29)
-
-#### Parameters
-
-##### ms
-
-`number`
-
-##### format
-
-`"minutes"` | `"seconds"` | `"milliseconds"`
-
-##### hoursMinLength
-
-`number` = `2`
-
-#### Returns
-
-`string`
-
-***
-
-### parseTimeStringToMs()
-
-```ts
-function parseTimeStringToMs(timeString): number;
-```
-
-Defined in: [packages/utils/src/time.ts:59](https://github.com/lucasols/utils/blob/main/packages/utils/src/time.ts#L59)
-
-#### Parameters
-
-##### timeString
-
-`string`
-
-#### Returns
-
-`number`

package/docs/timers.md

@@ -1,256 +0,0 @@
-[**@ls-stack/utils**](README.md)
-
-***
-
-[@ls-stack/utils](modules.md) / timers
-
-# timers
-
-## Type Aliases
-
-### CleanupTimer()
-
-```ts
-type CleanupTimer = () => void;
-```
-
-Defined in: [packages/utils/src/timers.ts:1](https://github.com/lucasols/utils/blob/main/packages/utils/src/timers.ts#L1)
-
-#### Returns
-
-`void`
-
-## Functions
-
-### createDebouncedTimeout()
-
-```ts
-function createDebouncedTimeout(ms, callback): object;
-```
-
-Defined in: [packages/utils/src/timers.ts:94](https://github.com/lucasols/utils/blob/main/packages/utils/src/timers.ts#L94)
-
-Creates a timeout that prevents concurrent executions.
-
-Each call to the `call` function will cancel any previous pending timeout
-and start a new one. This is useful for debouncing or ensuring only the
-last call executes after a delay.
-
-#### Parameters
-
-##### ms
-
-`number`
-
-The timeout duration in milliseconds
-
-##### callback
-
-() => `void`
-
-The function to execute when the timeout completes
-
-#### Returns
-
-`object`
-
-An object with `call` to trigger the timeout and `clean` to cancel it
-
-##### call()
-
-```ts
-call: () => void;
-```
-
-###### Returns
-
-`void`
-
-##### clean
-
-```ts
-clean: CleanupTimer;
-```
-
-#### Example
-
-```typescript
-const { call, clean } = createDebouncedTimeout(1000, () => {
-  console.log('Only the last call executes');
-});
-
-call(); // This will be cancelled
-call(); // This will be cancelled
-call(); // Only this one will execute after 1000ms
-
-// Or cancel all pending timeouts
-clean();
-```
-
-***
-
-### createInterval()
-
-```ts
-function createInterval(ms, callback): CleanupTimer;
-```
-
-Defined in: [packages/utils/src/timers.ts:56](https://github.com/lucasols/utils/blob/main/packages/utils/src/timers.ts#L56)
-
-Creates an interval with automatic cleanup capability.
-
-Returns a cleanup function that can be called to cancel the interval.
-The cleanup function is idempotent - calling it multiple times is safe.
-
-#### Parameters
-
-##### ms
-
-`number`
-
-The interval duration in milliseconds
-
-##### callback
-
-() => `void`
-
-The function to execute on each interval tick
-
-#### Returns
-
-[`CleanupTimer`](#cleanuptimer)
-
-A cleanup function that cancels the interval when called
-
-#### Example
-
-```typescript
-const cleanup = createInterval(1000, () => {
-  console.log('Interval tick');
-});
-
-// Stop the interval
-cleanup();
-```
-
-***
-
-### createTimeout()
-
-```ts
-function createTimeout(ms, callback): CleanupTimer;
-```
-
-Defined in: [packages/utils/src/timers.ts:23](https://github.com/lucasols/utils/blob/main/packages/utils/src/timers.ts#L23)
-
-Creates a timeout with automatic cleanup capability.
-
-Returns a cleanup function that can be called to cancel the timeout.
-The cleanup function is idempotent - calling it multiple times is safe.
-
-#### Parameters
-
-##### ms
-
-`number`
-
-The timeout duration in milliseconds
-
-##### callback
-
-() => `void`
-
-The function to execute when the timeout completes
-
-#### Returns
-
-[`CleanupTimer`](#cleanuptimer)
-
-A cleanup function that cancels the timeout when called
-
-#### Example
-
-```typescript
-const cleanup = createTimeout(1000, () => {
-  console.log('Timeout completed');
-});
-
-// Cancel the timeout before it completes
-cleanup();
-```
-
-***
-
-### createWaitUntil()
-
-```ts
-function createWaitUntil<T>(options): CleanupTimer;
-```
-
-Defined in: [packages/utils/src/timers.ts:144](https://github.com/lucasols/utils/blob/main/packages/utils/src/timers.ts#L144)
-
-Creates a timeout that waits for a condition to become true.
-
-Polls the condition function at regular intervals until it returns a truthy value,
-then calls the callback with that value. If the condition doesn't become true
-within the maximum wait time, the timeout expires without calling the callback.
-
-#### Type Parameters
-
-##### T
-
-`T` *extends* `object`
-
-The type of value returned by the condition function when true
-
-#### Parameters
-
-##### options
-
-Configuration options
-
-###### callback
-
-(`value`) => `void`
-
-Function to call when the condition becomes true
-
-###### checkIntervalMs?
-
-`number` = `20`
-
-How often to check the condition in milliseconds (default: 20)
-
-###### condition
-
-() => `false` \| `T`
-
-Function that returns false or a truthy value when the condition is met
-
-###### maxWaitMs
-
-`number`
-
-Maximum time to wait for the condition in milliseconds
-
-#### Returns
-
-[`CleanupTimer`](#cleanuptimer)
-
-A cleanup function that cancels the condition timeout
-
-#### Example
-
-```typescript
-const cleanup = createWaitUntil({
-  condition: () => document.getElementById('myElement'),
-  maxWaitMs: 5000,
-  callback: (element) => {
-    console.log('Element found:', element);
-  },
-  checkIntervalMs: 50
-});
-
-// Cancel the condition check
-cleanup();
-```