diff --git a/.changeset/tiny-jobs-behave.md b/.changeset/tiny-jobs-behave.md new file mode 100644 index 000000000..c5b005f37 --- /dev/null +++ b/.changeset/tiny-jobs-behave.md @@ -0,0 +1,7 @@ +--- +'@tanstack/preact-pacer': patch +'@tanstack/react-pacer': patch +'@tanstack/pacer': patch +--- + +fix: update return types to use Awaited for async functions diff --git a/docs/framework/angular/reference/functions/injectAsyncBatchedCallback.md b/docs/framework/angular/reference/functions/injectAsyncBatchedCallback.md index 78b24980d..cba6cf5aa 100644 --- a/docs/framework/angular/reference/functions/injectAsyncBatchedCallback.md +++ b/docs/framework/angular/reference/functions/injectAsyncBatchedCallback.md @@ -9,7 +9,7 @@ title: injectAsyncBatchedCallback function injectAsyncBatchedCallback(fn, options): (item) => Promise; ``` -Defined in: [angular-pacer/src/async-batcher/injectAsyncBatchedCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatchedCallback.ts#L42) +Defined in: [angular-pacer/src/async-batcher/injectAsyncBatchedCallback.ts:42](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatchedCallback.ts#L42) An Angular function that creates an async batched version of a callback function. This function is essentially a wrapper around `injectAsyncBatcher` that provides diff --git a/docs/framework/angular/reference/functions/injectAsyncBatcher.md b/docs/framework/angular/reference/functions/injectAsyncBatcher.md index c5352adb7..a56d7d0fc 100644 --- a/docs/framework/angular/reference/functions/injectAsyncBatcher.md +++ b/docs/framework/angular/reference/functions/injectAsyncBatcher.md @@ -12,7 +12,7 @@ function injectAsyncBatcher( selector): AngularAsyncBatcher; ``` -Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L96) +Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:96](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L96) An Angular function that creates and manages an AsyncBatcher instance. diff --git a/docs/framework/angular/reference/functions/injectAsyncDebouncedCallback.md b/docs/framework/angular/reference/functions/injectAsyncDebouncedCallback.md index 1c1eaef0c..64d1ab67b 100644 --- a/docs/framework/angular/reference/functions/injectAsyncDebouncedCallback.md +++ b/docs/framework/angular/reference/functions/injectAsyncDebouncedCallback.md @@ -9,7 +9,7 @@ title: injectAsyncDebouncedCallback function injectAsyncDebouncedCallback(fn, options): (...args) => Promise> | undefined>; ``` -Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncedCallback.ts#L40) +Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncedCallback.ts:40](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncedCallback.ts#L40) An Angular function that creates an async debounced version of a callback function. This function is essentially a wrapper around `injectAsyncDebouncer` that provides diff --git a/docs/framework/angular/reference/functions/injectAsyncDebouncer.md b/docs/framework/angular/reference/functions/injectAsyncDebouncer.md index ebbbbfe64..19ae923be 100644 --- a/docs/framework/angular/reference/functions/injectAsyncDebouncer.md +++ b/docs/framework/angular/reference/functions/injectAsyncDebouncer.md @@ -12,7 +12,7 @@ function injectAsyncDebouncer( selector): AngularAsyncDebouncer; ``` -Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:119](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L119) +Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:119](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L119) An Angular function that creates and manages an AsyncDebouncer instance. diff --git a/docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md b/docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md index 9c34f3558..483415479 100644 --- a/docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md +++ b/docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md @@ -12,7 +12,7 @@ function injectAsyncQueuedSignal( selector): AsyncQueuedSignal; ``` -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:52](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L52) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:52](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L52) An Angular function that creates an async queuer with managed state, combining Angular's signals with async queuing functionality. This function provides both the current queue state and queue control methods. diff --git a/docs/framework/angular/reference/functions/injectAsyncQueuer.md b/docs/framework/angular/reference/functions/injectAsyncQueuer.md index 952d12379..05d9a73f0 100644 --- a/docs/framework/angular/reference/functions/injectAsyncQueuer.md +++ b/docs/framework/angular/reference/functions/injectAsyncQueuer.md @@ -12,7 +12,7 @@ function injectAsyncQueuer( selector): AngularAsyncQueuer; ``` -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L96) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:96](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L96) An Angular function that creates and manages an AsyncQueuer instance. diff --git a/docs/framework/angular/reference/functions/injectAsyncRateLimitedCallback.md b/docs/framework/angular/reference/functions/injectAsyncRateLimitedCallback.md index a0bc18024..b6772bdb3 100644 --- a/docs/framework/angular/reference/functions/injectAsyncRateLimitedCallback.md +++ b/docs/framework/angular/reference/functions/injectAsyncRateLimitedCallback.md @@ -9,7 +9,7 @@ title: injectAsyncRateLimitedCallback function injectAsyncRateLimitedCallback(fn, options): (...args) => Promise> | undefined>; ``` -Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts:43](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts#L43) +Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts:43](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimitedCallback.ts#L43) An Angular function that creates an async rate-limited version of a callback function. This function is essentially a wrapper around `injectAsyncRateLimiter` that provides diff --git a/docs/framework/angular/reference/functions/injectAsyncRateLimiter.md b/docs/framework/angular/reference/functions/injectAsyncRateLimiter.md index 14e2bae50..04cf7c266 100644 --- a/docs/framework/angular/reference/functions/injectAsyncRateLimiter.md +++ b/docs/framework/angular/reference/functions/injectAsyncRateLimiter.md @@ -12,7 +12,7 @@ function injectAsyncRateLimiter( selector): AngularAsyncRateLimiter; ``` -Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:83](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L83) +Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:83](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L83) An Angular function that creates and manages an AsyncRateLimiter instance. diff --git a/docs/framework/angular/reference/functions/injectAsyncThrottledCallback.md b/docs/framework/angular/reference/functions/injectAsyncThrottledCallback.md index 79ee16812..2f7c159e7 100644 --- a/docs/framework/angular/reference/functions/injectAsyncThrottledCallback.md +++ b/docs/framework/angular/reference/functions/injectAsyncThrottledCallback.md @@ -9,7 +9,7 @@ title: injectAsyncThrottledCallback function injectAsyncThrottledCallback(fn, options): (...args) => Promise> | undefined>; ``` -Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts:41](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts#L41) +Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts:41](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts#L41) An Angular function that creates an async throttled version of a callback function. This function is essentially a wrapper around `injectAsyncThrottler` that provides diff --git a/docs/framework/angular/reference/functions/injectAsyncThrottler.md b/docs/framework/angular/reference/functions/injectAsyncThrottler.md index 92b1cc5c9..0eac2ecbf 100644 --- a/docs/framework/angular/reference/functions/injectAsyncThrottler.md +++ b/docs/framework/angular/reference/functions/injectAsyncThrottler.md @@ -12,7 +12,7 @@ function injectAsyncThrottler( selector): AngularAsyncThrottler; ``` -Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:98](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L98) +Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:98](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L98) An Angular function that creates and manages an AsyncThrottler instance. diff --git a/docs/framework/angular/reference/functions/injectBatchedCallback.md b/docs/framework/angular/reference/functions/injectBatchedCallback.md index 510d62133..5d7fb241b 100644 --- a/docs/framework/angular/reference/functions/injectBatchedCallback.md +++ b/docs/framework/angular/reference/functions/injectBatchedCallback.md @@ -9,7 +9,7 @@ title: injectBatchedCallback function injectBatchedCallback(fn, options): (item) => void; ``` -Defined in: [angular-pacer/src/batcher/injectBatchedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatchedCallback.ts#L40) +Defined in: [angular-pacer/src/batcher/injectBatchedCallback.ts:40](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatchedCallback.ts#L40) An Angular function that creates a batched version of a callback function. This function is essentially a wrapper around `injectBatcher` that provides diff --git a/docs/framework/angular/reference/functions/injectBatcher.md b/docs/framework/angular/reference/functions/injectBatcher.md index 34fa5a0bd..4c4d4db78 100644 --- a/docs/framework/angular/reference/functions/injectBatcher.md +++ b/docs/framework/angular/reference/functions/injectBatcher.md @@ -12,7 +12,7 @@ function injectBatcher( selector): AngularBatcher; ``` -Defined in: [angular-pacer/src/batcher/injectBatcher.ts:85](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L85) +Defined in: [angular-pacer/src/batcher/injectBatcher.ts:85](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L85) An Angular function that creates and manages a Batcher instance. diff --git a/docs/framework/angular/reference/functions/injectDebouncedCallback.md b/docs/framework/angular/reference/functions/injectDebouncedCallback.md index ccf75c755..941f6e6da 100644 --- a/docs/framework/angular/reference/functions/injectDebouncedCallback.md +++ b/docs/framework/angular/reference/functions/injectDebouncedCallback.md @@ -9,7 +9,7 @@ title: injectDebouncedCallback function injectDebouncedCallback(fn, options): (...args) => void; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedCallback.ts#L40) +Defined in: [angular-pacer/src/debouncer/injectDebouncedCallback.ts:40](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedCallback.ts#L40) An Angular function that creates a debounced version of a callback function. This function is essentially a wrapper around `injectDebouncer` that provides diff --git a/docs/framework/angular/reference/functions/injectDebouncedSignal.md b/docs/framework/angular/reference/functions/injectDebouncedSignal.md index 17d305f35..e129732aa 100644 --- a/docs/framework/angular/reference/functions/injectDebouncedSignal.md +++ b/docs/framework/angular/reference/functions/injectDebouncedSignal.md @@ -12,7 +12,7 @@ function injectDebouncedSignal( selector?): DebouncedSignal; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:63](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L63) +Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:63](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L63) An Angular function that creates a debounced state signal, combining Angular's signal with debouncing functionality. This function provides both the current debounced value and methods to update it. diff --git a/docs/framework/angular/reference/functions/injectDebouncedValue.md b/docs/framework/angular/reference/functions/injectDebouncedValue.md index 73a5e291a..202cb6778 100644 --- a/docs/framework/angular/reference/functions/injectDebouncedValue.md +++ b/docs/framework/angular/reference/functions/injectDebouncedValue.md @@ -14,7 +14,7 @@ function injectDebouncedValue( selector?): DebouncedSignal; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncedValue.ts:77](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedValue.ts#L77) +Defined in: [angular-pacer/src/debouncer/injectDebouncedValue.ts:77](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedValue.ts#L77) An Angular function that creates a debounced value that updates only after a specified delay. Unlike injectDebouncedSignal, this function automatically tracks changes to the input signal @@ -119,7 +119,7 @@ function injectDebouncedValue( selector?): DebouncedSignal; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncedValue.ts:82](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedValue.ts#L82) +Defined in: [angular-pacer/src/debouncer/injectDebouncedValue.ts:82](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedValue.ts#L82) An Angular function that creates a debounced value that updates only after a specified delay. Unlike injectDebouncedSignal, this function automatically tracks changes to the input signal diff --git a/docs/framework/angular/reference/functions/injectDebouncer.md b/docs/framework/angular/reference/functions/injectDebouncer.md index d40c71f5c..6a54a51e2 100644 --- a/docs/framework/angular/reference/functions/injectDebouncer.md +++ b/docs/framework/angular/reference/functions/injectDebouncer.md @@ -12,7 +12,7 @@ function injectDebouncer( selector): AngularDebouncer; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:109](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L109) +Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:109](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L109) An Angular function that creates and manages a Debouncer instance. diff --git a/docs/framework/angular/reference/functions/injectQueuedSignal.md b/docs/framework/angular/reference/functions/injectQueuedSignal.md index 5304edc89..677dfffd5 100644 --- a/docs/framework/angular/reference/functions/injectQueuedSignal.md +++ b/docs/framework/angular/reference/functions/injectQueuedSignal.md @@ -12,7 +12,7 @@ function injectQueuedSignal( selector): QueuedSignal; ``` -Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:43](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L43) +Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:43](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L43) An Angular function that creates a queuer with managed state, combining Angular's signals with queuing functionality. This function provides both the current queue state and queue control methods. diff --git a/docs/framework/angular/reference/functions/injectQueuedValue.md b/docs/framework/angular/reference/functions/injectQueuedValue.md index 9c3ed8576..ed87ba065 100644 --- a/docs/framework/angular/reference/functions/injectQueuedValue.md +++ b/docs/framework/angular/reference/functions/injectQueuedValue.md @@ -14,7 +14,7 @@ function injectQueuedValue( selector?): QueuedSignal; ``` -Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:31](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L31) +Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:31](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L31) An Angular function that creates a queued value that processes state changes in order with an optional delay. This function uses injectQueuedSignal internally to manage a queue of state changes and apply them sequentially. @@ -78,7 +78,7 @@ function injectQueuedValue( selector?): QueuedSignal; ``` -Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:42](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L42) +Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:42](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L42) An Angular function that creates a queued value that processes state changes in order with an optional delay. This function uses injectQueuedSignal internally to manage a queue of state changes and apply them sequentially. diff --git a/docs/framework/angular/reference/functions/injectQueuer.md b/docs/framework/angular/reference/functions/injectQueuer.md index 211d56d62..923034a5e 100644 --- a/docs/framework/angular/reference/functions/injectQueuer.md +++ b/docs/framework/angular/reference/functions/injectQueuer.md @@ -12,7 +12,7 @@ function injectQueuer( selector): AngularQueuer; ``` -Defined in: [angular-pacer/src/queuer/injectQueuer.ts:90](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L90) +Defined in: [angular-pacer/src/queuer/injectQueuer.ts:90](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L90) An Angular function that creates and manages a Queuer instance. diff --git a/docs/framework/angular/reference/functions/injectRateLimitedCallback.md b/docs/framework/angular/reference/functions/injectRateLimitedCallback.md index ae04820fe..933699b57 100644 --- a/docs/framework/angular/reference/functions/injectRateLimitedCallback.md +++ b/docs/framework/angular/reference/functions/injectRateLimitedCallback.md @@ -9,7 +9,7 @@ title: injectRateLimitedCallback function injectRateLimitedCallback(fn, options): (...args) => boolean; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedCallback.ts:39](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedCallback.ts#L39) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedCallback.ts:39](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedCallback.ts#L39) An Angular function that creates a rate-limited version of a callback function. This function is essentially a wrapper around `injectRateLimiter` that provides diff --git a/docs/framework/angular/reference/functions/injectRateLimitedSignal.md b/docs/framework/angular/reference/functions/injectRateLimitedSignal.md index 1410dd49d..6f1d47d53 100644 --- a/docs/framework/angular/reference/functions/injectRateLimitedSignal.md +++ b/docs/framework/angular/reference/functions/injectRateLimitedSignal.md @@ -12,7 +12,7 @@ function injectRateLimitedSignal( selector?): RateLimitedSignal; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:57](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L57) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:57](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L57) An Angular function that creates a rate-limited state signal, combining Angular's signal with rate limiting functionality. This function provides both the current rate-limited value and methods to update it. diff --git a/docs/framework/angular/reference/functions/injectRateLimitedValue.md b/docs/framework/angular/reference/functions/injectRateLimitedValue.md index 58742cf01..1c674b462 100644 --- a/docs/framework/angular/reference/functions/injectRateLimitedValue.md +++ b/docs/framework/angular/reference/functions/injectRateLimitedValue.md @@ -14,7 +14,7 @@ function injectRateLimitedValue( selector?): RateLimitedSignal; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedValue.ts:50](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedValue.ts#L50) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedValue.ts:50](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedValue.ts#L50) An Angular function that creates a rate-limited value that updates at most a certain number of times within a time window. Unlike injectRateLimitedSignal, this function automatically tracks changes to the input signal @@ -93,7 +93,7 @@ function injectRateLimitedValue( selector?): RateLimitedSignal; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedValue.ts:55](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedValue.ts#L55) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedValue.ts:55](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedValue.ts#L55) An Angular function that creates a rate-limited value that updates at most a certain number of times within a time window. Unlike injectRateLimitedSignal, this function automatically tracks changes to the input signal diff --git a/docs/framework/angular/reference/functions/injectRateLimiter.md b/docs/framework/angular/reference/functions/injectRateLimiter.md index d77c36663..72c2f55b4 100644 --- a/docs/framework/angular/reference/functions/injectRateLimiter.md +++ b/docs/framework/angular/reference/functions/injectRateLimiter.md @@ -12,7 +12,7 @@ function injectRateLimiter( selector): AngularRateLimiter; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:114](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L114) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:114](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L114) An Angular function that creates and manages a RateLimiter instance. diff --git a/docs/framework/angular/reference/functions/injectThrottledCallback.md b/docs/framework/angular/reference/functions/injectThrottledCallback.md index e11c559d7..0ea3c1185 100644 --- a/docs/framework/angular/reference/functions/injectThrottledCallback.md +++ b/docs/framework/angular/reference/functions/injectThrottledCallback.md @@ -9,7 +9,7 @@ title: injectThrottledCallback function injectThrottledCallback(fn, options): (...args) => void; ``` -Defined in: [angular-pacer/src/throttler/injectThrottledCallback.ts:39](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledCallback.ts#L39) +Defined in: [angular-pacer/src/throttler/injectThrottledCallback.ts:39](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledCallback.ts#L39) An Angular function that creates a throttled version of a callback function. This function is essentially a wrapper around `injectThrottler` that provides diff --git a/docs/framework/angular/reference/functions/injectThrottledSignal.md b/docs/framework/angular/reference/functions/injectThrottledSignal.md index bdf7d3e53..91d65237a 100644 --- a/docs/framework/angular/reference/functions/injectThrottledSignal.md +++ b/docs/framework/angular/reference/functions/injectThrottledSignal.md @@ -12,7 +12,7 @@ function injectThrottledSignal( selector?): ThrottledSignal; ``` -Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:64](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L64) +Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:64](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L64) An Angular function that creates a throttled state signal, combining Angular's signal with throttling functionality. This function provides both the current throttled value and methods to update it. diff --git a/docs/framework/angular/reference/functions/injectThrottledValue.md b/docs/framework/angular/reference/functions/injectThrottledValue.md index 1dc50fa3d..48bf9c822 100644 --- a/docs/framework/angular/reference/functions/injectThrottledValue.md +++ b/docs/framework/angular/reference/functions/injectThrottledValue.md @@ -14,7 +14,7 @@ function injectThrottledValue( selector?): ThrottledSignal; ``` -Defined in: [angular-pacer/src/throttler/injectThrottledValue.ts:75](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledValue.ts#L75) +Defined in: [angular-pacer/src/throttler/injectThrottledValue.ts:75](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledValue.ts#L75) An Angular function that creates a throttled value that updates at most once within a specified time window. Unlike injectThrottledSignal, this function automatically tracks changes to the input signal @@ -118,7 +118,7 @@ function injectThrottledValue( selector?): ThrottledSignal; ``` -Defined in: [angular-pacer/src/throttler/injectThrottledValue.ts:80](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledValue.ts#L80) +Defined in: [angular-pacer/src/throttler/injectThrottledValue.ts:80](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledValue.ts#L80) An Angular function that creates a throttled value that updates at most once within a specified time window. Unlike injectThrottledSignal, this function automatically tracks changes to the input signal diff --git a/docs/framework/angular/reference/functions/injectThrottler.md b/docs/framework/angular/reference/functions/injectThrottler.md index aab1eb489..c78467e83 100644 --- a/docs/framework/angular/reference/functions/injectThrottler.md +++ b/docs/framework/angular/reference/functions/injectThrottler.md @@ -12,7 +12,7 @@ function injectThrottler( selector): AngularThrottler; ``` -Defined in: [angular-pacer/src/throttler/injectThrottler.ts:109](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L109) +Defined in: [angular-pacer/src/throttler/injectThrottler.ts:109](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L109) An Angular function that creates and manages a Throttler instance. diff --git a/docs/framework/angular/reference/functions/providePacerOptions.md b/docs/framework/angular/reference/functions/providePacerOptions.md index 9528fecfc..21f8c610a 100644 --- a/docs/framework/angular/reference/functions/providePacerOptions.md +++ b/docs/framework/angular/reference/functions/providePacerOptions.md @@ -9,7 +9,7 @@ title: providePacerOptions function providePacerOptions(options): Provider; ``` -Defined in: [angular-pacer/src/provider/pacer-provider.ts:33](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/provider/pacer-provider.ts#L33) +Defined in: [angular-pacer/src/provider/pacer-provider.ts:33](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/provider/pacer-provider.ts#L33) Provides default options for all Pacer utilities in the Angular application. Use this function when configuring your Angular application to set default options diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncBatcher.md b/docs/framework/angular/reference/interfaces/AngularAsyncBatcher.md index fb63c2c3d..f58ef82b5 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncBatcher.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncBatcher.md @@ -5,7 +5,7 @@ title: AngularAsyncBatcher # Interface: AngularAsyncBatcher\ -Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:24](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L24) +Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:24](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:24](https://g readonly state: Signal>; ``` -Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:33](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L33) +Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:33](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L33) Reactive state signal that will be updated when the async batcher state changes @@ -44,7 +44,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:38](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L38) +Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:38](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L38) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncBatcherOptions.md b/docs/framework/angular/reference/interfaces/AngularAsyncBatcherOptions.md index be55902c5..f0b3ffd08 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncBatcherOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncBatcherOptions.md @@ -5,7 +5,7 @@ title: AngularAsyncBatcherOptions # Interface: AngularAsyncBatcherOptions\ -Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:12](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L12) +Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:12](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L12) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:12](https://g optional onUnmount: (batcher) => void; ``` -Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:21](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L21) +Defined in: [angular-pacer/src/async-batcher/injectAsyncBatcher.ts:21](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L21) Optional callback invoked when the component is destroyed. Receives the batcher instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), cancel(), add logging, etc. diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncDebouncer.md b/docs/framework/angular/reference/interfaces/AngularAsyncDebouncer.md index e11e05ff1..aaac693e1 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncDebouncer.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncDebouncer.md @@ -5,7 +5,7 @@ title: AngularAsyncDebouncer # Interface: AngularAsyncDebouncer\ -Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:25](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L25) +Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:25](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L25) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:25](https readonly state: Signal>; ``` -Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:34](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L34) +Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:34](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L34) Reactive state signal that will be updated when the async debouncer state changes @@ -44,7 +44,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:39](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L39) +Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:39](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L39) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncDebouncerOptions.md b/docs/framework/angular/reference/interfaces/AngularAsyncDebouncerOptions.md index e4a838f19..c830390e8 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncDebouncerOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncDebouncerOptions.md @@ -5,7 +5,7 @@ title: AngularAsyncDebouncerOptions # Interface: AngularAsyncDebouncerOptions\ -Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L13) +Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:13](https optional onUnmount: (debouncer) => void; ``` -Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:22](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L22) +Defined in: [angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts:22](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L22) Optional callback invoked when the component is destroyed. Receives the debouncer instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), cancel(), add logging, etc. diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncQueuer.md b/docs/framework/angular/reference/interfaces/AngularAsyncQueuer.md index 0aedf5979..dad9dd16c 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncQueuer.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncQueuer.md @@ -5,7 +5,7 @@ title: AngularAsyncQueuer # Interface: AngularAsyncQueuer\ -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L24) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:24](https://git readonly state: Signal>; ``` -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:33](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L33) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:33](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L33) Reactive state signal that will be updated when the async queuer state changes @@ -44,7 +44,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:38](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L38) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:38](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L38) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncQueuerOptions.md b/docs/framework/angular/reference/interfaces/AngularAsyncQueuerOptions.md index 898b3728f..2973d525f 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncQueuerOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncQueuerOptions.md @@ -5,7 +5,7 @@ title: AngularAsyncQueuerOptions # Interface: AngularAsyncQueuerOptions\ -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:12](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L12) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:12](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L12) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:12](https://git optional onUnmount: (queuer) => void; ``` -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L21) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L21) Optional callback invoked when the component is destroyed. Receives the queuer instance. When provided, replaces the default cleanup (stop + abort); use it to call flush(), stop(), add logging, etc. diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncRateLimiter.md b/docs/framework/angular/reference/interfaces/AngularAsyncRateLimiter.md index a1031e024..655950695 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncRateLimiter.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncRateLimiter.md @@ -5,7 +5,7 @@ title: AngularAsyncRateLimiter # Interface: AngularAsyncRateLimiter\ -Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:24](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L24) +Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:24](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:24]( readonly state: Signal>; ``` -Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:33](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L33) +Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:33](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L33) Reactive state signal that will be updated when the async rate limiter state changes @@ -44,7 +44,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:38](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L38) +Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:38](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L38) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncRateLimiterOptions.md b/docs/framework/angular/reference/interfaces/AngularAsyncRateLimiterOptions.md index e645aa95c..df400271f 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncRateLimiterOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncRateLimiterOptions.md @@ -5,7 +5,7 @@ title: AngularAsyncRateLimiterOptions # Interface: AngularAsyncRateLimiterOptions\ -Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L13) +Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:13]( optional onUnmount: (rateLimiter) => void; ``` -Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L21) +Defined in: [angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts:21](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-rate-limiter/injectAsyncRateLimiter.ts#L21) Optional callback invoked when the component is destroyed. Receives the rate limiter instance. When provided, replaces the default cleanup (abort). diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncThrottler.md b/docs/framework/angular/reference/interfaces/AngularAsyncThrottler.md index 59446a1d6..f42ec95c7 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncThrottler.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncThrottler.md @@ -5,7 +5,7 @@ title: AngularAsyncThrottler # Interface: AngularAsyncThrottler\ -Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:25](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L25) +Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:25](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L25) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:25](https readonly state: Signal>; ``` -Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:34](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L34) +Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:34](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L34) Reactive state signal that will be updated when the async throttler state changes @@ -44,7 +44,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:39](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L39) +Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:39](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L39) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularAsyncThrottlerOptions.md b/docs/framework/angular/reference/interfaces/AngularAsyncThrottlerOptions.md index 910ac16c4..b745d1179 100644 --- a/docs/framework/angular/reference/interfaces/AngularAsyncThrottlerOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularAsyncThrottlerOptions.md @@ -5,7 +5,7 @@ title: AngularAsyncThrottlerOptions # Interface: AngularAsyncThrottlerOptions\ -Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L13) +Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:13](https optional onUnmount: (throttler) => void; ``` -Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:22](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L22) +Defined in: [angular-pacer/src/async-throttler/injectAsyncThrottler.ts:22](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L22) Optional callback invoked when the component is destroyed. Receives the throttler instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), cancel(), add logging, etc. diff --git a/docs/framework/angular/reference/interfaces/AngularBatcher.md b/docs/framework/angular/reference/interfaces/AngularBatcher.md index b3f69832d..42bb9c26e 100644 --- a/docs/framework/angular/reference/interfaces/AngularBatcher.md +++ b/docs/framework/angular/reference/interfaces/AngularBatcher.md @@ -5,7 +5,7 @@ title: AngularBatcher # Interface: AngularBatcher\ -Defined in: [angular-pacer/src/batcher/injectBatcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L20) +Defined in: [angular-pacer/src/batcher/injectBatcher.ts:20](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L20) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/batcher/injectBatcher.ts:20](https://github.com/T readonly state: Signal>; ``` -Defined in: [angular-pacer/src/batcher/injectBatcher.ts:29](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L29) +Defined in: [angular-pacer/src/batcher/injectBatcher.ts:29](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L29) Reactive state signal that will be updated when the batcher state changes @@ -44,7 +44,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/batcher/injectBatcher.ts:34](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L34) +Defined in: [angular-pacer/src/batcher/injectBatcher.ts:34](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L34) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularBatcherOptions.md b/docs/framework/angular/reference/interfaces/AngularBatcherOptions.md index c3a66ef10..e145f734b 100644 --- a/docs/framework/angular/reference/interfaces/AngularBatcherOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularBatcherOptions.md @@ -5,7 +5,7 @@ title: AngularBatcherOptions # Interface: AngularBatcherOptions\ -Defined in: [angular-pacer/src/batcher/injectBatcher.ts:9](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L9) +Defined in: [angular-pacer/src/batcher/injectBatcher.ts:9](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L9) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/batcher/injectBatcher.ts:9](https://github.com/Ta optional onUnmount: (batcher) => void; ``` -Defined in: [angular-pacer/src/batcher/injectBatcher.ts:17](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L17) +Defined in: [angular-pacer/src/batcher/injectBatcher.ts:17](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L17) Optional callback invoked when the component is destroyed. Receives the batcher instance. When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc. diff --git a/docs/framework/angular/reference/interfaces/AngularDebouncer.md b/docs/framework/angular/reference/interfaces/AngularDebouncer.md index 82292fab7..f5149d289 100644 --- a/docs/framework/angular/reference/interfaces/AngularDebouncer.md +++ b/docs/framework/angular/reference/interfaces/AngularDebouncer.md @@ -5,7 +5,7 @@ title: AngularDebouncer # Interface: AngularDebouncer\ -Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L24) +Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:24](https://github.c readonly state: Signal>; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:33](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L33) +Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:33](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L33) Reactive state signal that will be updated when the debouncer state changes @@ -44,7 +44,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:38](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L38) +Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:38](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L38) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularDebouncerOptions.md b/docs/framework/angular/reference/interfaces/AngularDebouncerOptions.md index d916ed74b..178e8ab91 100644 --- a/docs/framework/angular/reference/interfaces/AngularDebouncerOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularDebouncerOptions.md @@ -5,7 +5,7 @@ title: AngularDebouncerOptions # Interface: AngularDebouncerOptions\ -Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L13) +Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:13](https://github.c optional onUnmount: (debouncer) => void; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L21) +Defined in: [angular-pacer/src/debouncer/injectDebouncer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L21) Optional callback invoked when the component is destroyed. Receives the debouncer instance. When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc. diff --git a/docs/framework/angular/reference/interfaces/AngularQueuer.md b/docs/framework/angular/reference/interfaces/AngularQueuer.md index 558015401..75bd7cd44 100644 --- a/docs/framework/angular/reference/interfaces/AngularQueuer.md +++ b/docs/framework/angular/reference/interfaces/AngularQueuer.md @@ -5,7 +5,7 @@ title: AngularQueuer # Interface: AngularQueuer\ -Defined in: [angular-pacer/src/queuer/injectQueuer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L20) +Defined in: [angular-pacer/src/queuer/injectQueuer.ts:20](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L20) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/queuer/injectQueuer.ts:20](https://github.com/Tan readonly state: Signal>; ``` -Defined in: [angular-pacer/src/queuer/injectQueuer.ts:29](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L29) +Defined in: [angular-pacer/src/queuer/injectQueuer.ts:29](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L29) Reactive state signal that will be updated when the queuer state changes @@ -44,7 +44,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/queuer/injectQueuer.ts:34](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L34) +Defined in: [angular-pacer/src/queuer/injectQueuer.ts:34](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L34) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularQueuerOptions.md b/docs/framework/angular/reference/interfaces/AngularQueuerOptions.md index 6497cecce..43558b9ca 100644 --- a/docs/framework/angular/reference/interfaces/AngularQueuerOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularQueuerOptions.md @@ -5,7 +5,7 @@ title: AngularQueuerOptions # Interface: AngularQueuerOptions\ -Defined in: [angular-pacer/src/queuer/injectQueuer.ts:9](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L9) +Defined in: [angular-pacer/src/queuer/injectQueuer.ts:9](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L9) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/queuer/injectQueuer.ts:9](https://github.com/TanS optional onUnmount: (queuer) => void; ``` -Defined in: [angular-pacer/src/queuer/injectQueuer.ts:17](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L17) +Defined in: [angular-pacer/src/queuer/injectQueuer.ts:17](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L17) Optional callback invoked when the component is destroyed. Receives the queuer instance. When provided, replaces the default cleanup (stop); use it to call flush(), stop(), add logging, etc. diff --git a/docs/framework/angular/reference/interfaces/AngularRateLimiter.md b/docs/framework/angular/reference/interfaces/AngularRateLimiter.md index b46b0c863..abcd8913f 100644 --- a/docs/framework/angular/reference/interfaces/AngularRateLimiter.md +++ b/docs/framework/angular/reference/interfaces/AngularRateLimiter.md @@ -5,7 +5,7 @@ title: AngularRateLimiter # Interface: AngularRateLimiter\ -Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:23](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L23) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:23](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L23) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:23](https://git readonly state: Signal>; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:32](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L32) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:32](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L32) Reactive state signal that will be updated when the rate limiter state changes @@ -44,7 +44,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:37](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L37) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:37](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L37) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularRateLimiterOptions.md b/docs/framework/angular/reference/interfaces/AngularRateLimiterOptions.md index 256b09cd1..b322d78c6 100644 --- a/docs/framework/angular/reference/interfaces/AngularRateLimiterOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularRateLimiterOptions.md @@ -5,7 +5,7 @@ title: AngularRateLimiterOptions # Interface: AngularRateLimiterOptions\ -Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L13) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:13](https://git optional onUnmount: (rateLimiter) => void; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:20](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L20) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimiter.ts:20](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimiter.ts#L20) Optional callback invoked when the component is destroyed. Receives the rate limiter instance. diff --git a/docs/framework/angular/reference/interfaces/AngularThrottler.md b/docs/framework/angular/reference/interfaces/AngularThrottler.md index ae42c3e91..6188ffae5 100644 --- a/docs/framework/angular/reference/interfaces/AngularThrottler.md +++ b/docs/framework/angular/reference/interfaces/AngularThrottler.md @@ -5,7 +5,7 @@ title: AngularThrottler # Interface: AngularThrottler\ -Defined in: [angular-pacer/src/throttler/injectThrottler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L24) +Defined in: [angular-pacer/src/throttler/injectThrottler.ts:24](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/throttler/injectThrottler.ts:24](https://github.c readonly state: Signal>; ``` -Defined in: [angular-pacer/src/throttler/injectThrottler.ts:33](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L33) +Defined in: [angular-pacer/src/throttler/injectThrottler.ts:33](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L33) Reactive state signal that will be updated when the throttler state changes @@ -44,7 +44,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [angular-pacer/src/throttler/injectThrottler.ts:38](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L38) +Defined in: [angular-pacer/src/throttler/injectThrottler.ts:38](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L38) #### Deprecated diff --git a/docs/framework/angular/reference/interfaces/AngularThrottlerOptions.md b/docs/framework/angular/reference/interfaces/AngularThrottlerOptions.md index 08befb004..45c0a84e2 100644 --- a/docs/framework/angular/reference/interfaces/AngularThrottlerOptions.md +++ b/docs/framework/angular/reference/interfaces/AngularThrottlerOptions.md @@ -5,7 +5,7 @@ title: AngularThrottlerOptions # Interface: AngularThrottlerOptions\ -Defined in: [angular-pacer/src/throttler/injectThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L13) +Defined in: [angular-pacer/src/throttler/injectThrottler.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [angular-pacer/src/throttler/injectThrottler.ts:13](https://github.c optional onUnmount: (throttler) => void; ``` -Defined in: [angular-pacer/src/throttler/injectThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L21) +Defined in: [angular-pacer/src/throttler/injectThrottler.ts:21](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottler.ts#L21) Optional callback invoked when the component is destroyed. Receives the throttler instance. When provided, replaces the default cleanup (cancel); use it to call flush(), cancel(), add logging, etc. diff --git a/docs/framework/angular/reference/interfaces/AsyncQueuedSignal.md b/docs/framework/angular/reference/interfaces/AsyncQueuedSignal.md index 889c95eab..9ca4eb642 100644 --- a/docs/framework/angular/reference/interfaces/AsyncQueuedSignal.md +++ b/docs/framework/angular/reference/interfaces/AsyncQueuedSignal.md @@ -5,7 +5,7 @@ title: AsyncQueuedSignal # Interface: AsyncQueuedSignal()\ -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:9](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L9) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:9](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L9) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:9](https: AsyncQueuedSignal(): TValue[]; ``` -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:10](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L10) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:10](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L10) ## Returns @@ -36,7 +36,7 @@ Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:10](https addItem: (item, position?, runOnItemsChange?) => boolean; ``` -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:11](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L11) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:11](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L11) Adds an item to the queue. If the queue is full, the item is rejected and onReject is called. Items can be inserted based on priority or at the front/back depending on configuration. @@ -74,4 +74,4 @@ queuer.addItem('task2', 'front'); queuer: AngularAsyncQueuer; ``` -Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:12](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L12) +Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:12](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L12) diff --git a/docs/framework/angular/reference/interfaces/DebouncedSignal.md b/docs/framework/angular/reference/interfaces/DebouncedSignal.md index ccb0aec5c..5306c927c 100644 --- a/docs/framework/angular/reference/interfaces/DebouncedSignal.md +++ b/docs/framework/angular/reference/interfaces/DebouncedSignal.md @@ -5,7 +5,7 @@ title: DebouncedSignal # Interface: DebouncedSignal()\ -Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:11](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L11) +Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:11](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L11) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:11](https://gi DebouncedSignal(): TValue; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:12](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L12) +Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:12](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L12) ## Returns @@ -36,7 +36,7 @@ Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:12](https://gi debouncer: AngularDebouncer, TSelected>; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:14](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L14) +Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:14](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L14) *** @@ -46,4 +46,4 @@ Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:14](https://gi set: Setter; ``` -Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L13) +Defined in: [angular-pacer/src/debouncer/injectDebouncedSignal.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedSignal.ts#L13) diff --git a/docs/framework/angular/reference/interfaces/QueuedSignal.md b/docs/framework/angular/reference/interfaces/QueuedSignal.md index 3e2842f51..2198604d0 100644 --- a/docs/framework/angular/reference/interfaces/QueuedSignal.md +++ b/docs/framework/angular/reference/interfaces/QueuedSignal.md @@ -5,7 +5,7 @@ title: QueuedSignal # Interface: QueuedSignal()\ -Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:6](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L6) +Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:6](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L6) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:6](https://github.co QueuedSignal(): TValue[]; ``` -Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:7](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L7) +Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:7](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L7) ## Returns @@ -36,7 +36,7 @@ Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:7](https://github.co addItem: (item, position?, runOnItemsChange?) => boolean; ``` -Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:8](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L8) +Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:8](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L8) Adds an item to the queue. If the queue is full, the item is rejected and onReject is called. Items can be inserted based on priority or at the front/back depending on configuration. @@ -75,4 +75,4 @@ queuer.addItem('task2', 'front'); queuer: AngularQueuer; ``` -Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:9](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L9) +Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:9](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L9) diff --git a/docs/framework/angular/reference/interfaces/RateLimitedSignal.md b/docs/framework/angular/reference/interfaces/RateLimitedSignal.md index 6a1d8bea8..6c75bf760 100644 --- a/docs/framework/angular/reference/interfaces/RateLimitedSignal.md +++ b/docs/framework/angular/reference/interfaces/RateLimitedSignal.md @@ -5,7 +5,7 @@ title: RateLimitedSignal # Interface: RateLimitedSignal()\ -Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:11](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L11) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:11](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L11) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:11](https RateLimitedSignal(): TValue; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:12](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L12) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:12](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L12) ## Returns @@ -36,7 +36,7 @@ Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:12](https rateLimiter: AngularRateLimiter, TSelected>; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:14](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L14) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:14](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L14) *** @@ -46,4 +46,4 @@ Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:14](https set: Setter; ``` -Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L13) +Defined in: [angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts#L13) diff --git a/docs/framework/angular/reference/interfaces/ThrottledSignal.md b/docs/framework/angular/reference/interfaces/ThrottledSignal.md index 306cc6047..350e337df 100644 --- a/docs/framework/angular/reference/interfaces/ThrottledSignal.md +++ b/docs/framework/angular/reference/interfaces/ThrottledSignal.md @@ -5,7 +5,7 @@ title: ThrottledSignal # Interface: ThrottledSignal()\ -Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:11](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L11) +Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:11](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L11) ## Type Parameters @@ -22,7 +22,7 @@ Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:11](https://gi ThrottledSignal(): TValue; ``` -Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:12](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L12) +Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:12](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L12) ## Returns @@ -36,7 +36,7 @@ Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:12](https://gi set: Setter; ``` -Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:13](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L13) +Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:13](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L13) *** @@ -46,4 +46,4 @@ Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:13](https://gi throttler: AngularThrottler, TSelected>; ``` -Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:14](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L14) +Defined in: [angular-pacer/src/throttler/injectThrottledSignal.ts:14](https://github.com/ghostd/pacer/blob/main/packages/angular-pacer/src/throttler/injectThrottledSignal.ts#L14) diff --git a/docs/framework/preact/reference/functions/PacerProvider.md b/docs/framework/preact/reference/functions/PacerProvider.md index cc5190e6b..3a372e4e0 100644 --- a/docs/framework/preact/reference/functions/PacerProvider.md +++ b/docs/framework/preact/reference/functions/PacerProvider.md @@ -9,7 +9,7 @@ title: PacerProvider function PacerProvider(__namedParameters): Element; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:45](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L45) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:45](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L45) ## Parameters diff --git a/docs/framework/preact/reference/functions/useAsyncBatchedCallback.md b/docs/framework/preact/reference/functions/useAsyncBatchedCallback.md index 47c8db867..4a698bb5f 100644 --- a/docs/framework/preact/reference/functions/useAsyncBatchedCallback.md +++ b/docs/framework/preact/reference/functions/useAsyncBatchedCallback.md @@ -9,7 +9,7 @@ title: useAsyncBatchedCallback function useAsyncBatchedCallback(fn, options): (item) => Promise; ``` -Defined in: [preact-pacer/src/async-batcher/useAsyncBatchedCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatchedCallback.ts#L42) +Defined in: [preact-pacer/src/async-batcher/useAsyncBatchedCallback.ts:42](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatchedCallback.ts#L42) A Preact hook that creates a batched version of an async callback function. This hook is a convenient wrapper around the `useAsyncBatcher` hook, diff --git a/docs/framework/preact/reference/functions/useAsyncBatcher.md b/docs/framework/preact/reference/functions/useAsyncBatcher.md index bbdbae422..71eccb01c 100644 --- a/docs/framework/preact/reference/functions/useAsyncBatcher.md +++ b/docs/framework/preact/reference/functions/useAsyncBatcher.md @@ -12,7 +12,7 @@ function useAsyncBatcher( selector): PreactAsyncBatcher; ``` -Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:235](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L235) +Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:235](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L235) A Preact hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items. diff --git a/docs/framework/preact/reference/functions/useAsyncDebouncedCallback.md b/docs/framework/preact/reference/functions/useAsyncDebouncedCallback.md index db52685c8..a768c02fe 100644 --- a/docs/framework/preact/reference/functions/useAsyncDebouncedCallback.md +++ b/docs/framework/preact/reference/functions/useAsyncDebouncedCallback.md @@ -6,10 +6,10 @@ title: useAsyncDebouncedCallback # Function: useAsyncDebouncedCallback() ```ts -function useAsyncDebouncedCallback(fn, options): (...args) => Promise>; +function useAsyncDebouncedCallback(fn, options): (...args) => Promise>>; ``` -Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts:44](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts#L44) +Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts:44](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts#L44) A Preact hook that creates a debounced version of an async callback function. This hook is a convenient wrapper around the `useAsyncDebouncer` hook, @@ -50,7 +50,7 @@ Consider using the `useAsyncDebouncer` hook instead. ## Returns ```ts -(...args): Promise>; +(...args): Promise>>; ``` ### Parameters @@ -61,7 +61,7 @@ Consider using the `useAsyncDebouncer` hook instead. ### Returns -`Promise`\<`ReturnType`\<`TFn`\>\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\> ## Example diff --git a/docs/framework/preact/reference/functions/useAsyncDebouncer.md b/docs/framework/preact/reference/functions/useAsyncDebouncer.md index d788ca56c..b5ba79151 100644 --- a/docs/framework/preact/reference/functions/useAsyncDebouncer.md +++ b/docs/framework/preact/reference/functions/useAsyncDebouncer.md @@ -12,7 +12,7 @@ function useAsyncDebouncer( selector): PreactAsyncDebouncer; ``` -Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:214](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L214) +Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:214](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L214) A low-level Preact hook that creates an `AsyncDebouncer` instance to delay execution of an async function. diff --git a/docs/framework/preact/reference/functions/useAsyncQueuedState.md b/docs/framework/preact/reference/functions/useAsyncQueuedState.md index 1e52c1e85..00080c42b 100644 --- a/docs/framework/preact/reference/functions/useAsyncQueuedState.md +++ b/docs/framework/preact/reference/functions/useAsyncQueuedState.md @@ -12,7 +12,7 @@ function useAsyncQueuedState( selector?): [TValue[], PreactAsyncQueuer]; ``` -Defined in: [preact-pacer/src/async-queuer/useAsyncQueuedState.ts:151](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuedState.ts#L151) +Defined in: [preact-pacer/src/async-queuer/useAsyncQueuedState.ts:151](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuedState.ts#L151) A higher-level Preact hook that creates an `AsyncQueuer` instance with built-in state management. diff --git a/docs/framework/preact/reference/functions/useAsyncQueuer.md b/docs/framework/preact/reference/functions/useAsyncQueuer.md index e36a89567..de25746bc 100644 --- a/docs/framework/preact/reference/functions/useAsyncQueuer.md +++ b/docs/framework/preact/reference/functions/useAsyncQueuer.md @@ -12,7 +12,7 @@ function useAsyncQueuer( selector): PreactAsyncQueuer; ``` -Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:235](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L235) +Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:235](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L235) A lower-level Preact hook that creates an `AsyncQueuer` instance for managing an async queue of items. diff --git a/docs/framework/preact/reference/functions/useAsyncRateLimitedCallback.md b/docs/framework/preact/reference/functions/useAsyncRateLimitedCallback.md index 9ecfa3431..40e555f21 100644 --- a/docs/framework/preact/reference/functions/useAsyncRateLimitedCallback.md +++ b/docs/framework/preact/reference/functions/useAsyncRateLimitedCallback.md @@ -6,10 +6,10 @@ title: useAsyncRateLimitedCallback # Function: useAsyncRateLimitedCallback() ```ts -function useAsyncRateLimitedCallback(fn, options): (...args) => Promise>; +function useAsyncRateLimitedCallback(fn, options): (...args) => Promise>>; ``` -Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts:59](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts#L59) +Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts:59](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts#L59) A Preact hook that creates a rate-limited version of an async callback function. This hook is a convenient wrapper around the `useAsyncRateLimiter` hook, @@ -64,7 +64,7 @@ Consider using the `useAsyncRateLimiter` hook instead. ## Returns ```ts -(...args): Promise>; +(...args): Promise>>; ``` ### Parameters @@ -75,7 +75,7 @@ Consider using the `useAsyncRateLimiter` hook instead. ### Returns -`Promise`\<`ReturnType`\<`TFn`\>\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\> ## Example diff --git a/docs/framework/preact/reference/functions/useAsyncRateLimiter.md b/docs/framework/preact/reference/functions/useAsyncRateLimiter.md index 7c25e8ed6..a7ecc91b7 100644 --- a/docs/framework/preact/reference/functions/useAsyncRateLimiter.md +++ b/docs/framework/preact/reference/functions/useAsyncRateLimiter.md @@ -12,7 +12,7 @@ function useAsyncRateLimiter( selector): PreactAsyncRateLimiter; ``` -Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:231](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L231) +Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:231](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L231) A low-level Preact hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window. diff --git a/docs/framework/preact/reference/functions/useAsyncThrottledCallback.md b/docs/framework/preact/reference/functions/useAsyncThrottledCallback.md index 82aa308a2..e75c91ac9 100644 --- a/docs/framework/preact/reference/functions/useAsyncThrottledCallback.md +++ b/docs/framework/preact/reference/functions/useAsyncThrottledCallback.md @@ -6,10 +6,10 @@ title: useAsyncThrottledCallback # Function: useAsyncThrottledCallback() ```ts -function useAsyncThrottledCallback(fn, options): (...args) => Promise>; +function useAsyncThrottledCallback(fn, options): (...args) => Promise>>; ``` -Defined in: [preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts#L42) +Defined in: [preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts:42](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts#L42) A Preact hook that creates a throttled version of an async callback function. This hook is a convenient wrapper around the `useAsyncThrottler` hook, @@ -51,7 +51,7 @@ Consider using the `useAsyncThrottler` hook instead. ## Returns ```ts -(...args): Promise>; +(...args): Promise>>; ``` ### Parameters @@ -62,7 +62,7 @@ Consider using the `useAsyncThrottler` hook instead. ### Returns -`Promise`\<`ReturnType`\<`TFn`\>\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\> ## Example diff --git a/docs/framework/preact/reference/functions/useAsyncThrottler.md b/docs/framework/preact/reference/functions/useAsyncThrottler.md index 0784d4ba9..fe01f651a 100644 --- a/docs/framework/preact/reference/functions/useAsyncThrottler.md +++ b/docs/framework/preact/reference/functions/useAsyncThrottler.md @@ -12,7 +12,7 @@ function useAsyncThrottler( selector): PreactAsyncThrottler; ``` -Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:225](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L225) +Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:225](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L225) A low-level Preact hook that creates an `AsyncThrottler` instance to limit how often an async function can execute. diff --git a/docs/framework/preact/reference/functions/useBatchedCallback.md b/docs/framework/preact/reference/functions/useBatchedCallback.md index 2147301eb..be91527d4 100644 --- a/docs/framework/preact/reference/functions/useBatchedCallback.md +++ b/docs/framework/preact/reference/functions/useBatchedCallback.md @@ -9,7 +9,7 @@ title: useBatchedCallback function useBatchedCallback(fn, options): (item) => void; ``` -Defined in: [preact-pacer/src/batcher/useBatchedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/batcher/useBatchedCallback.ts#L40) +Defined in: [preact-pacer/src/batcher/useBatchedCallback.ts:40](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/batcher/useBatchedCallback.ts#L40) A Preact hook that creates a batched version of a callback function. This hook is essentially a wrapper around the basic `batch` function diff --git a/docs/framework/preact/reference/functions/useBatcher.md b/docs/framework/preact/reference/functions/useBatcher.md index 21bfb1d7b..062acd987 100644 --- a/docs/framework/preact/reference/functions/useBatcher.md +++ b/docs/framework/preact/reference/functions/useBatcher.md @@ -12,7 +12,7 @@ function useBatcher( selector): PreactBatcher; ``` -Defined in: [preact-pacer/src/batcher/useBatcher.ts:183](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L183) +Defined in: [preact-pacer/src/batcher/useBatcher.ts:183](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L183) A Preact hook that creates and manages a Batcher instance. diff --git a/docs/framework/preact/reference/functions/useDebouncedCallback.md b/docs/framework/preact/reference/functions/useDebouncedCallback.md index 204a9c108..9a9f82c80 100644 --- a/docs/framework/preact/reference/functions/useDebouncedCallback.md +++ b/docs/framework/preact/reference/functions/useDebouncedCallback.md @@ -9,7 +9,7 @@ title: useDebouncedCallback function useDebouncedCallback(fn, options): (...args) => void; ``` -Defined in: [preact-pacer/src/debouncer/useDebouncedCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncedCallback.ts#L42) +Defined in: [preact-pacer/src/debouncer/useDebouncedCallback.ts:42](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncedCallback.ts#L42) A Preact hook that creates a debounced version of a callback function. This hook is essentially a wrapper around the basic `debounce` function diff --git a/docs/framework/preact/reference/functions/useDebouncedState.md b/docs/framework/preact/reference/functions/useDebouncedState.md index 79f789902..4b37f3f77 100644 --- a/docs/framework/preact/reference/functions/useDebouncedState.md +++ b/docs/framework/preact/reference/functions/useDebouncedState.md @@ -12,7 +12,7 @@ function useDebouncedState( selector?): [TValue, Dispatch>, PreactDebouncer>, TSelected>]; ``` -Defined in: [preact-pacer/src/debouncer/useDebouncedState.ts:79](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncedState.ts#L79) +Defined in: [preact-pacer/src/debouncer/useDebouncedState.ts:79](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncedState.ts#L79) A Preact hook that creates a debounced state value, combining Preact's useState with debouncing functionality. This hook provides both the current debounced value and methods to update it. diff --git a/docs/framework/preact/reference/functions/useDebouncedValue.md b/docs/framework/preact/reference/functions/useDebouncedValue.md index bc3155369..3cee8728e 100644 --- a/docs/framework/preact/reference/functions/useDebouncedValue.md +++ b/docs/framework/preact/reference/functions/useDebouncedValue.md @@ -12,7 +12,7 @@ function useDebouncedValue( selector?): [TValue, PreactDebouncer>, TSelected>]; ``` -Defined in: [preact-pacer/src/debouncer/useDebouncedValue.ts:88](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncedValue.ts#L88) +Defined in: [preact-pacer/src/debouncer/useDebouncedValue.ts:88](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncedValue.ts#L88) A Preact hook that creates a debounced value that updates only after a specified delay. Unlike useDebouncedState, this hook automatically tracks changes to the input value diff --git a/docs/framework/preact/reference/functions/useDebouncer.md b/docs/framework/preact/reference/functions/useDebouncer.md index 3b049bb94..808f589d7 100644 --- a/docs/framework/preact/reference/functions/useDebouncer.md +++ b/docs/framework/preact/reference/functions/useDebouncer.md @@ -12,7 +12,7 @@ function useDebouncer( selector): PreactDebouncer; ``` -Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:163](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L163) +Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:163](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L163) A Preact hook that creates and manages a Debouncer instance. diff --git a/docs/framework/preact/reference/functions/useDefaultPacerOptions.md b/docs/framework/preact/reference/functions/useDefaultPacerOptions.md index 1ddcfc777..852023af8 100644 --- a/docs/framework/preact/reference/functions/useDefaultPacerOptions.md +++ b/docs/framework/preact/reference/functions/useDefaultPacerOptions.md @@ -9,7 +9,7 @@ title: useDefaultPacerOptions function useDefaultPacerOptions(): PacerProviderOptions; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:67](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L67) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:67](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L67) ## Returns diff --git a/docs/framework/preact/reference/functions/usePacerContext.md b/docs/framework/preact/reference/functions/usePacerContext.md index d469ac332..c43524109 100644 --- a/docs/framework/preact/reference/functions/usePacerContext.md +++ b/docs/framework/preact/reference/functions/usePacerContext.md @@ -9,7 +9,7 @@ title: usePacerContext function usePacerContext(): PacerContextValue | null; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:63](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L63) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:63](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L63) ## Returns diff --git a/docs/framework/preact/reference/functions/useQueuedState.md b/docs/framework/preact/reference/functions/useQueuedState.md index 6ea0ddda4..583acb9cf 100644 --- a/docs/framework/preact/reference/functions/useQueuedState.md +++ b/docs/framework/preact/reference/functions/useQueuedState.md @@ -12,7 +12,7 @@ function useQueuedState( selector?): [TValue[], (item, position?, runOnItemsChange?) => boolean, PreactQueuer]; ``` -Defined in: [preact-pacer/src/queuer/useQueuedState.ts:119](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuedState.ts#L119) +Defined in: [preact-pacer/src/queuer/useQueuedState.ts:119](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuedState.ts#L119) A Preact hook that creates a queuer with managed state, combining Preact's useState with queuing functionality. This hook provides both the current queue state and queue control methods. diff --git a/docs/framework/preact/reference/functions/useQueuedValue.md b/docs/framework/preact/reference/functions/useQueuedValue.md index 6e809cc98..197162bc9 100644 --- a/docs/framework/preact/reference/functions/useQueuedValue.md +++ b/docs/framework/preact/reference/functions/useQueuedValue.md @@ -12,7 +12,7 @@ function useQueuedValue( selector?): [TValue, PreactQueuer]; ``` -Defined in: [preact-pacer/src/queuer/useQueuedValue.ts:103](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuedValue.ts#L103) +Defined in: [preact-pacer/src/queuer/useQueuedValue.ts:103](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuedValue.ts#L103) A Preact hook that creates a queued value that processes state changes in order with an optional delay. This hook uses useQueuer internally to manage a queue of state changes and apply them sequentially. diff --git a/docs/framework/preact/reference/functions/useQueuer.md b/docs/framework/preact/reference/functions/useQueuer.md index c9cdf7424..329dd6c30 100644 --- a/docs/framework/preact/reference/functions/useQueuer.md +++ b/docs/framework/preact/reference/functions/useQueuer.md @@ -12,7 +12,7 @@ function useQueuer( selector): PreactQueuer; ``` -Defined in: [preact-pacer/src/queuer/useQueuer.ts:194](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L194) +Defined in: [preact-pacer/src/queuer/useQueuer.ts:194](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L194) A Preact hook that creates and manages a Queuer instance. diff --git a/docs/framework/preact/reference/functions/useRateLimitedCallback.md b/docs/framework/preact/reference/functions/useRateLimitedCallback.md index 1cfb7495b..9f66b89b8 100644 --- a/docs/framework/preact/reference/functions/useRateLimitedCallback.md +++ b/docs/framework/preact/reference/functions/useRateLimitedCallback.md @@ -9,7 +9,7 @@ title: useRateLimitedCallback function useRateLimitedCallback(fn, options): (...args) => boolean; ``` -Defined in: [preact-pacer/src/rate-limiter/useRateLimitedCallback.ts:59](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimitedCallback.ts#L59) +Defined in: [preact-pacer/src/rate-limiter/useRateLimitedCallback.ts:59](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimitedCallback.ts#L59) A Preact hook that creates a rate-limited version of a callback function. This hook is essentially a wrapper around the basic `rateLimiter` function diff --git a/docs/framework/preact/reference/functions/useRateLimitedState.md b/docs/framework/preact/reference/functions/useRateLimitedState.md index 2e3f42600..4e44ebd00 100644 --- a/docs/framework/preact/reference/functions/useRateLimitedState.md +++ b/docs/framework/preact/reference/functions/useRateLimitedState.md @@ -12,7 +12,7 @@ function useRateLimitedState( selector?): [TValue, Dispatch>, PreactRateLimiter>, TSelected>]; ``` -Defined in: [preact-pacer/src/rate-limiter/useRateLimitedState.ts:108](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimitedState.ts#L108) +Defined in: [preact-pacer/src/rate-limiter/useRateLimitedState.ts:108](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimitedState.ts#L108) A Preact hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window. This hook combines Preact's useState with rate limiting functionality to provide controlled state updates. diff --git a/docs/framework/preact/reference/functions/useRateLimitedValue.md b/docs/framework/preact/reference/functions/useRateLimitedValue.md index fa70e4fb2..ec66a71b6 100644 --- a/docs/framework/preact/reference/functions/useRateLimitedValue.md +++ b/docs/framework/preact/reference/functions/useRateLimitedValue.md @@ -12,7 +12,7 @@ function useRateLimitedValue( selector?): [TValue, PreactRateLimiter>, TSelected>]; ``` -Defined in: [preact-pacer/src/rate-limiter/useRateLimitedValue.ts:97](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimitedValue.ts#L97) +Defined in: [preact-pacer/src/rate-limiter/useRateLimitedValue.ts:97](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimitedValue.ts#L97) A high-level Preact hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window. This hook uses Preact's useState internally to manage the rate-limited state. diff --git a/docs/framework/preact/reference/functions/useRateLimiter.md b/docs/framework/preact/reference/functions/useRateLimiter.md index 0e2853a37..710f5748e 100644 --- a/docs/framework/preact/reference/functions/useRateLimiter.md +++ b/docs/framework/preact/reference/functions/useRateLimiter.md @@ -12,7 +12,7 @@ function useRateLimiter( selector): PreactRateLimiter; ``` -Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:190](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L190) +Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:190](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L190) A low-level Preact hook that creates a `RateLimiter` instance to enforce rate limits on function execution. diff --git a/docs/framework/preact/reference/functions/useThrottledCallback.md b/docs/framework/preact/reference/functions/useThrottledCallback.md index 26126f112..d03d2ac0f 100644 --- a/docs/framework/preact/reference/functions/useThrottledCallback.md +++ b/docs/framework/preact/reference/functions/useThrottledCallback.md @@ -9,7 +9,7 @@ title: useThrottledCallback function useThrottledCallback(fn, options): (...args) => void; ``` -Defined in: [preact-pacer/src/throttler/useThrottledCallback.ts:43](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottledCallback.ts#L43) +Defined in: [preact-pacer/src/throttler/useThrottledCallback.ts:43](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottledCallback.ts#L43) A Preact hook that creates a throttled version of a callback function. This hook is essentially a wrapper around the basic `throttle` function diff --git a/docs/framework/preact/reference/functions/useThrottledState.md b/docs/framework/preact/reference/functions/useThrottledState.md index 026605858..5702e9c61 100644 --- a/docs/framework/preact/reference/functions/useThrottledState.md +++ b/docs/framework/preact/reference/functions/useThrottledState.md @@ -12,7 +12,7 @@ function useThrottledState( selector?): [TValue, Dispatch>, PreactThrottler>, TSelected>]; ``` -Defined in: [preact-pacer/src/throttler/useThrottledState.ts:91](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottledState.ts#L91) +Defined in: [preact-pacer/src/throttler/useThrottledState.ts:91](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottledState.ts#L91) A Preact hook that creates a throttled state value that updates at most once within a specified time window. This hook combines Preact's useState with throttling functionality to provide controlled state updates. diff --git a/docs/framework/preact/reference/functions/useThrottledValue.md b/docs/framework/preact/reference/functions/useThrottledValue.md index c55d3b08e..a42a2c76a 100644 --- a/docs/framework/preact/reference/functions/useThrottledValue.md +++ b/docs/framework/preact/reference/functions/useThrottledValue.md @@ -12,7 +12,7 @@ function useThrottledValue( selector?): [TValue, PreactThrottler>, TSelected>]; ``` -Defined in: [preact-pacer/src/throttler/useThrottledValue.ts:83](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottledValue.ts#L83) +Defined in: [preact-pacer/src/throttler/useThrottledValue.ts:83](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottledValue.ts#L83) A high-level Preact hook that creates a throttled version of a value that updates at most once within a specified time window. This hook uses Preact's useState internally to manage the throttled state. diff --git a/docs/framework/preact/reference/functions/useThrottler.md b/docs/framework/preact/reference/functions/useThrottler.md index 9b8cf398e..4cfd2cc08 100644 --- a/docs/framework/preact/reference/functions/useThrottler.md +++ b/docs/framework/preact/reference/functions/useThrottler.md @@ -12,7 +12,7 @@ function useThrottler( selector): PreactThrottler; ``` -Defined in: [preact-pacer/src/throttler/useThrottler.ts:168](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L168) +Defined in: [preact-pacer/src/throttler/useThrottler.ts:168](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L168) A low-level Preact hook that creates a `Throttler` instance that limits how often the provided function can execute. diff --git a/docs/framework/preact/reference/interfaces/PacerProviderOptions.md b/docs/framework/preact/reference/interfaces/PacerProviderOptions.md index 35b9371d7..35fc76959 100644 --- a/docs/framework/preact/reference/interfaces/PacerProviderOptions.md +++ b/docs/framework/preact/reference/interfaces/PacerProviderOptions.md @@ -5,7 +5,7 @@ title: PacerProviderOptions # Interface: PacerProviderOptions -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:19](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L19) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:19](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L19) ## Properties @@ -15,7 +15,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:19](https://github.com/ optional asyncBatcher: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:20](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L20) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:20](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L20) *** @@ -25,7 +25,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:20](https://github.com/ optional asyncDebouncer: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:21](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L21) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:21](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L21) *** @@ -35,7 +35,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:21](https://github.com/ optional asyncQueuer: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:22](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L22) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:22](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L22) *** @@ -45,7 +45,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:22](https://github.com/ optional asyncRateLimiter: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:23](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L23) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:23](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L23) *** @@ -55,7 +55,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:23](https://github.com/ optional asyncThrottler: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:24](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L24) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:24](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L24) *** @@ -65,7 +65,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:24](https://github.com/ optional batcher: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:25](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L25) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:25](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L25) *** @@ -75,7 +75,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:25](https://github.com/ optional debouncer: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:26](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L26) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:26](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L26) *** @@ -85,7 +85,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:26](https://github.com/ optional queuer: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:27](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L27) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:27](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L27) *** @@ -95,7 +95,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:27](https://github.com/ optional rateLimiter: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:28](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L28) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:28](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L28) *** @@ -105,4 +105,4 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:28](https://github.com/ optional throttler: Partial>; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:29](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L29) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:29](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L29) diff --git a/docs/framework/preact/reference/interfaces/PacerProviderProps.md b/docs/framework/preact/reference/interfaces/PacerProviderProps.md index e5d502b48..eec403254 100644 --- a/docs/framework/preact/reference/interfaces/PacerProviderProps.md +++ b/docs/framework/preact/reference/interfaces/PacerProviderProps.md @@ -5,7 +5,7 @@ title: PacerProviderProps # Interface: PacerProviderProps -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:38](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L38) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:38](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L38) ## Properties @@ -15,7 +15,7 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:38](https://github.com/ children: ComponentChildren; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:39](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L39) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:39](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L39) *** @@ -25,4 +25,4 @@ Defined in: [preact-pacer/src/provider/PacerProvider.tsx:39](https://github.com/ optional defaultOptions: PacerProviderOptions; ``` -Defined in: [preact-pacer/src/provider/PacerProvider.tsx:40](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L40) +Defined in: [preact-pacer/src/provider/PacerProvider.tsx:40](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/provider/PacerProvider.tsx#L40) diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncBatcher.md b/docs/framework/preact/reference/interfaces/PreactAsyncBatcher.md index 9c36b00ce..bdf92b672 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncBatcher.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncBatcher.md @@ -5,7 +5,7 @@ title: PreactAsyncBatcher # Interface: PreactAsyncBatcher\ -Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:23](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L23) +Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:23](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L23) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:23](https://githu readonly state: Readonly; ``` -Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:49](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L49) +Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:49](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L49) Reactive state that will be updated and re-rendered when the batcher state changes @@ -44,7 +44,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:55](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L55) +Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:55](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L55) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:40](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L40) +Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:40](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L40) A Preact HOC (Higher Order Component) that allows you to subscribe to the async batcher state. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncBatcherOptions.md b/docs/framework/preact/reference/interfaces/PreactAsyncBatcherOptions.md index 03dea9869..62925d5e8 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncBatcherOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncBatcherOptions.md @@ -5,7 +5,7 @@ title: PreactAsyncBatcherOptions # Interface: PreactAsyncBatcherOptions\ -Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:12](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L12) +Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:12](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L12) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:12](https://githu optional onUnmount: (batcher) => void; ``` -Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L20) +Defined in: [preact-pacer/src/async-batcher/useAsyncBatcher.ts:20](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-batcher/useAsyncBatcher.ts#L20) Optional callback invoked when the component unmounts. Receives the batcher instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncDebouncer.md b/docs/framework/preact/reference/interfaces/PreactAsyncDebouncer.md index 84ba7f0fd..908b88dc9 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncDebouncer.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncDebouncer.md @@ -5,7 +5,7 @@ title: PreactAsyncDebouncer # Interface: PreactAsyncDebouncer\ -Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L24) +Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:24](https://g readonly state: Readonly; ``` -Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:50](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L50) +Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:50](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L50) Reactive state that will be updated and re-rendered when the debouncer state changes @@ -44,7 +44,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:56](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L56) +Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:56](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L41) +Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:41](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L41) A Preact HOC (Higher Order Component) that allows you to subscribe to the async debouncer state. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncDebouncerOptions.md b/docs/framework/preact/reference/interfaces/PreactAsyncDebouncerOptions.md index 7107b50d5..58bd37de3 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncDebouncerOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncDebouncerOptions.md @@ -5,7 +5,7 @@ title: PreactAsyncDebouncerOptions # Interface: PreactAsyncDebouncerOptions\ -Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L13) +Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:13](https://g optional onUnmount: (debouncer) => void; ``` -Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L21) +Defined in: [preact-pacer/src/async-debouncer/useAsyncDebouncer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-debouncer/useAsyncDebouncer.ts#L21) Optional callback invoked when the component unmounts. Receives the debouncer instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncQueuer.md b/docs/framework/preact/reference/interfaces/PreactAsyncQueuer.md index 7f895a72c..4b2e5a139 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncQueuer.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncQueuer.md @@ -5,7 +5,7 @@ title: PreactAsyncQueuer # Interface: PreactAsyncQueuer\ -Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:23](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L23) +Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:23](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L23) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:23](https://github. readonly state: Readonly; ``` -Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:49](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L49) +Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:49](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L49) Reactive state that will be updated and re-rendered when the queuer state changes @@ -44,7 +44,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:55](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L55) +Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:55](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L55) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:40](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L40) +Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:40](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L40) A Preact HOC (Higher Order Component) that allows you to subscribe to the async queuer state. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncQueuerOptions.md b/docs/framework/preact/reference/interfaces/PreactAsyncQueuerOptions.md index d43826767..ae0169103 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncQueuerOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncQueuerOptions.md @@ -5,7 +5,7 @@ title: PreactAsyncQueuerOptions # Interface: PreactAsyncQueuerOptions\ -Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:12](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L12) +Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:12](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L12) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:12](https://github. optional onUnmount: (queuer) => void; ``` -Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L20) +Defined in: [preact-pacer/src/async-queuer/useAsyncQueuer.ts:20](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-queuer/useAsyncQueuer.ts#L20) Optional callback invoked when the component unmounts. Receives the queuer instance. When provided, replaces the default cleanup (stop + abort); use it to call flush(), flushAsBatch(), stop(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncRateLimiter.md b/docs/framework/preact/reference/interfaces/PreactAsyncRateLimiter.md index 9f975dac5..c8d1f512d 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncRateLimiter.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncRateLimiter.md @@ -5,7 +5,7 @@ title: PreactAsyncRateLimiter # Interface: PreactAsyncRateLimiter\ -Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:24](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L24) +Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:24](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:24](http readonly state: Readonly; ``` -Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:50](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L50) +Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:50](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L50) Reactive state that will be updated and re-rendered when the rate limiter state changes @@ -44,7 +44,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:56](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L56) +Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:56](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:41](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L41) +Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:41](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L41) A Preact HOC (Higher Order Component) that allows you to subscribe to the async rate limiter state. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncRateLimiterOptions.md b/docs/framework/preact/reference/interfaces/PreactAsyncRateLimiterOptions.md index 492c3b2eb..96715e134 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncRateLimiterOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncRateLimiterOptions.md @@ -5,7 +5,7 @@ title: PreactAsyncRateLimiterOptions # Interface: PreactAsyncRateLimiterOptions\ -Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L13) +Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:13](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:13](http optional onUnmount: (rateLimiter) => void; ``` -Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L21) +Defined in: [preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:21](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L21) Optional callback invoked when the component unmounts. Receives the rate limiter instance. When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncThrottler.md b/docs/framework/preact/reference/interfaces/PreactAsyncThrottler.md index ac50d2fd3..e84b2d37e 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncThrottler.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncThrottler.md @@ -5,7 +5,7 @@ title: PreactAsyncThrottler # Interface: PreactAsyncThrottler\ -Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L24) +Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:24](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:24](https://g readonly state: Readonly; ``` -Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:50](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L50) +Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:50](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L50) Reactive state that will be updated and re-rendered when the throttler state changes @@ -44,7 +44,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:56](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L56) +Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:56](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:41](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L41) +Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:41](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L41) A Preact HOC (Higher Order Component) that allows you to subscribe to the async throttler state. diff --git a/docs/framework/preact/reference/interfaces/PreactAsyncThrottlerOptions.md b/docs/framework/preact/reference/interfaces/PreactAsyncThrottlerOptions.md index 7f150f4d2..0efe711df 100644 --- a/docs/framework/preact/reference/interfaces/PreactAsyncThrottlerOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactAsyncThrottlerOptions.md @@ -5,7 +5,7 @@ title: PreactAsyncThrottlerOptions # Interface: PreactAsyncThrottlerOptions\ -Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L13) +Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:13](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:13](https://g optional onUnmount: (throttler) => void; ``` -Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L21) +Defined in: [preact-pacer/src/async-throttler/useAsyncThrottler.ts:21](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/async-throttler/useAsyncThrottler.ts#L21) Optional callback invoked when the component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactBatcher.md b/docs/framework/preact/reference/interfaces/PreactBatcher.md index b532ce4ff..2586d9b80 100644 --- a/docs/framework/preact/reference/interfaces/PreactBatcher.md +++ b/docs/framework/preact/reference/interfaces/PreactBatcher.md @@ -5,7 +5,7 @@ title: PreactBatcher # Interface: PreactBatcher\ -Defined in: [preact-pacer/src/batcher/useBatcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L20) +Defined in: [preact-pacer/src/batcher/useBatcher.ts:20](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L20) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/batcher/useBatcher.ts:20](https://github.com/TanSt readonly state: Readonly; ``` -Defined in: [preact-pacer/src/batcher/useBatcher.ts:46](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L46) +Defined in: [preact-pacer/src/batcher/useBatcher.ts:46](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L46) Reactive state that will be updated and re-rendered when the batcher state changes @@ -44,7 +44,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/batcher/useBatcher.ts:52](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L52) +Defined in: [preact-pacer/src/batcher/useBatcher.ts:52](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L52) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/batcher/useBatcher.ts:37](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L37) +Defined in: [preact-pacer/src/batcher/useBatcher.ts:37](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L37) A Preact HOC (Higher Order Component) that allows you to subscribe to the batcher state. diff --git a/docs/framework/preact/reference/interfaces/PreactBatcherOptions.md b/docs/framework/preact/reference/interfaces/PreactBatcherOptions.md index 6c2fb9b55..253498fcb 100644 --- a/docs/framework/preact/reference/interfaces/PreactBatcherOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactBatcherOptions.md @@ -5,7 +5,7 @@ title: PreactBatcherOptions # Interface: PreactBatcherOptions\ -Defined in: [preact-pacer/src/batcher/useBatcher.ts:9](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L9) +Defined in: [preact-pacer/src/batcher/useBatcher.ts:9](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L9) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/batcher/useBatcher.ts:9](https://github.com/TanSta optional onUnmount: (batcher) => void; ``` -Defined in: [preact-pacer/src/batcher/useBatcher.ts:17](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L17) +Defined in: [preact-pacer/src/batcher/useBatcher.ts:17](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/batcher/useBatcher.ts#L17) Optional callback invoked when the component unmounts. Receives the batcher instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactDebouncer.md b/docs/framework/preact/reference/interfaces/PreactDebouncer.md index c80f13ea7..fb07251af 100644 --- a/docs/framework/preact/reference/interfaces/PreactDebouncer.md +++ b/docs/framework/preact/reference/interfaces/PreactDebouncer.md @@ -5,7 +5,7 @@ title: PreactDebouncer # Interface: PreactDebouncer\ -Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L24) +Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:24](https://github.com/T readonly state: Readonly; ``` -Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:50](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L50) +Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:50](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L50) Reactive state that will be updated and re-rendered when the debouncer state changes @@ -44,7 +44,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:56](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L56) +Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:56](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L41) +Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:41](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L41) A Preact HOC (Higher Order Component) that allows you to subscribe to the debouncer state. diff --git a/docs/framework/preact/reference/interfaces/PreactDebouncerOptions.md b/docs/framework/preact/reference/interfaces/PreactDebouncerOptions.md index 55dbcbb5e..33e5018f2 100644 --- a/docs/framework/preact/reference/interfaces/PreactDebouncerOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactDebouncerOptions.md @@ -5,7 +5,7 @@ title: PreactDebouncerOptions # Interface: PreactDebouncerOptions\ -Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L13) +Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:13](https://github.com/T optional onUnmount: (debouncer) => void; ``` -Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L21) +Defined in: [preact-pacer/src/debouncer/useDebouncer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/debouncer/useDebouncer.ts#L21) Optional callback invoked when the component unmounts. Receives the debouncer instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactQueuer.md b/docs/framework/preact/reference/interfaces/PreactQueuer.md index a047c0894..92601b21e 100644 --- a/docs/framework/preact/reference/interfaces/PreactQueuer.md +++ b/docs/framework/preact/reference/interfaces/PreactQueuer.md @@ -5,7 +5,7 @@ title: PreactQueuer # Interface: PreactQueuer\ -Defined in: [preact-pacer/src/queuer/useQueuer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L20) +Defined in: [preact-pacer/src/queuer/useQueuer.ts:20](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L20) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/queuer/useQueuer.ts:20](https://github.com/TanStac readonly state: Readonly; ``` -Defined in: [preact-pacer/src/queuer/useQueuer.ts:46](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L46) +Defined in: [preact-pacer/src/queuer/useQueuer.ts:46](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L46) Reactive state that will be updated and re-rendered when the queuer state changes @@ -44,7 +44,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/queuer/useQueuer.ts:52](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L52) +Defined in: [preact-pacer/src/queuer/useQueuer.ts:52](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L52) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/queuer/useQueuer.ts:37](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L37) +Defined in: [preact-pacer/src/queuer/useQueuer.ts:37](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L37) A Preact HOC (Higher Order Component) that allows you to subscribe to the queuer state. diff --git a/docs/framework/preact/reference/interfaces/PreactQueuerOptions.md b/docs/framework/preact/reference/interfaces/PreactQueuerOptions.md index 41b36964f..8b21c0760 100644 --- a/docs/framework/preact/reference/interfaces/PreactQueuerOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactQueuerOptions.md @@ -5,7 +5,7 @@ title: PreactQueuerOptions # Interface: PreactQueuerOptions\ -Defined in: [preact-pacer/src/queuer/useQueuer.ts:9](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L9) +Defined in: [preact-pacer/src/queuer/useQueuer.ts:9](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L9) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/queuer/useQueuer.ts:9](https://github.com/TanStack optional onUnmount: (queuer) => void; ``` -Defined in: [preact-pacer/src/queuer/useQueuer.ts:17](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L17) +Defined in: [preact-pacer/src/queuer/useQueuer.ts:17](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/queuer/useQueuer.ts#L17) Optional callback invoked when the component unmounts. Receives the queuer instance. When provided, replaces the default cleanup (stop); use it to call flush(), flushAsBatch(), stop(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactRateLimiter.md b/docs/framework/preact/reference/interfaces/PreactRateLimiter.md index ce1d6b183..41c20dcfa 100644 --- a/docs/framework/preact/reference/interfaces/PreactRateLimiter.md +++ b/docs/framework/preact/reference/interfaces/PreactRateLimiter.md @@ -5,7 +5,7 @@ title: PreactRateLimiter # Interface: PreactRateLimiter\ -Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:24](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L24) +Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:24](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:24](https://github. readonly state: Readonly; ``` -Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:50](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L50) +Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:50](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L50) Reactive state that will be updated and re-rendered when the rate limiter state changes @@ -44,7 +44,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>; ``` -Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:56](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L56) +Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:56](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:41](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L41) +Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:41](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L41) A Preact HOC (Higher Order Component) that allows you to subscribe to the rate limiter state. diff --git a/docs/framework/preact/reference/interfaces/PreactRateLimiterOptions.md b/docs/framework/preact/reference/interfaces/PreactRateLimiterOptions.md index 232b9d92a..8d14b0f1d 100644 --- a/docs/framework/preact/reference/interfaces/PreactRateLimiterOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactRateLimiterOptions.md @@ -5,7 +5,7 @@ title: PreactRateLimiterOptions # Interface: PreactRateLimiterOptions\ -Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L13) +Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:13](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:13](https://github. optional onUnmount: (rateLimiter) => void; ``` -Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L21) +Defined in: [preact-pacer/src/rate-limiter/useRateLimiter.ts:21](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/rate-limiter/useRateLimiter.ts#L21) Optional callback invoked when the component unmounts. Receives the rate limiter instance. When provided, replaces the default cleanup; use it to call reset(), add logging, etc. diff --git a/docs/framework/preact/reference/interfaces/PreactThrottler.md b/docs/framework/preact/reference/interfaces/PreactThrottler.md index fae3f286a..bab384069 100644 --- a/docs/framework/preact/reference/interfaces/PreactThrottler.md +++ b/docs/framework/preact/reference/interfaces/PreactThrottler.md @@ -5,7 +5,7 @@ title: PreactThrottler # Interface: PreactThrottler\ -Defined in: [preact-pacer/src/throttler/useThrottler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L24) +Defined in: [preact-pacer/src/throttler/useThrottler.ts:24](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/throttler/useThrottler.ts:24](https://github.com/T readonly state: Readonly; ``` -Defined in: [preact-pacer/src/throttler/useThrottler.ts:50](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L50) +Defined in: [preact-pacer/src/throttler/useThrottler.ts:50](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L50) Reactive state that will be updated and re-rendered when the throttler state changes @@ -44,7 +44,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [preact-pacer/src/throttler/useThrottler.ts:56](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L56) +Defined in: [preact-pacer/src/throttler/useThrottler.ts:56](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ComponentChildren; ``` -Defined in: [preact-pacer/src/throttler/useThrottler.ts:41](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L41) +Defined in: [preact-pacer/src/throttler/useThrottler.ts:41](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L41) A Preact HOC (Higher Order Component) that allows you to subscribe to the throttler state. diff --git a/docs/framework/preact/reference/interfaces/PreactThrottlerOptions.md b/docs/framework/preact/reference/interfaces/PreactThrottlerOptions.md index e703c9741..25b265d83 100644 --- a/docs/framework/preact/reference/interfaces/PreactThrottlerOptions.md +++ b/docs/framework/preact/reference/interfaces/PreactThrottlerOptions.md @@ -5,7 +5,7 @@ title: PreactThrottlerOptions # Interface: PreactThrottlerOptions\ -Defined in: [preact-pacer/src/throttler/useThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L13) +Defined in: [preact-pacer/src/throttler/useThrottler.ts:13](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [preact-pacer/src/throttler/useThrottler.ts:13](https://github.com/T optional onUnmount: (throttler) => void; ``` -Defined in: [preact-pacer/src/throttler/useThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L21) +Defined in: [preact-pacer/src/throttler/useThrottler.ts:21](https://github.com/ghostd/pacer/blob/main/packages/preact-pacer/src/throttler/useThrottler.ts#L21) Optional callback invoked when the component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/react/reference/functions/PacerProvider.md b/docs/framework/react/reference/functions/PacerProvider.md index 8e1b3e876..77fd07cef 100644 --- a/docs/framework/react/reference/functions/PacerProvider.md +++ b/docs/framework/react/reference/functions/PacerProvider.md @@ -9,7 +9,7 @@ title: PacerProvider function PacerProvider(__namedParameters): Element; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:44](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L44) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:44](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L44) ## Parameters diff --git a/docs/framework/react/reference/functions/useAsyncBatchedCallback.md b/docs/framework/react/reference/functions/useAsyncBatchedCallback.md index 24bbef5d4..00883db0a 100644 --- a/docs/framework/react/reference/functions/useAsyncBatchedCallback.md +++ b/docs/framework/react/reference/functions/useAsyncBatchedCallback.md @@ -9,7 +9,7 @@ title: useAsyncBatchedCallback function useAsyncBatchedCallback(fn, options): (item) => Promise; ``` -Defined in: [react-pacer/src/async-batcher/useAsyncBatchedCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatchedCallback.ts#L42) +Defined in: [react-pacer/src/async-batcher/useAsyncBatchedCallback.ts:42](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatchedCallback.ts#L42) A React hook that creates a batched version of an async callback function. This hook is a convenient wrapper around the `useAsyncBatcher` hook, diff --git a/docs/framework/react/reference/functions/useAsyncBatcher.md b/docs/framework/react/reference/functions/useAsyncBatcher.md index 7912b9ebc..732f47475 100644 --- a/docs/framework/react/reference/functions/useAsyncBatcher.md +++ b/docs/framework/react/reference/functions/useAsyncBatcher.md @@ -12,7 +12,7 @@ function useAsyncBatcher( selector): ReactAsyncBatcher; ``` -Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:235](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L235) +Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:235](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L235) A React hook that creates an `AsyncBatcher` instance for managing asynchronous batches of items. diff --git a/docs/framework/react/reference/functions/useAsyncDebouncedCallback.md b/docs/framework/react/reference/functions/useAsyncDebouncedCallback.md index df82e2607..e41d73503 100644 --- a/docs/framework/react/reference/functions/useAsyncDebouncedCallback.md +++ b/docs/framework/react/reference/functions/useAsyncDebouncedCallback.md @@ -6,10 +6,10 @@ title: useAsyncDebouncedCallback # Function: useAsyncDebouncedCallback() ```ts -function useAsyncDebouncedCallback(fn, options): (...args) => Promise>; +function useAsyncDebouncedCallback(fn, options): (...args) => Promise>>; ``` -Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts:44](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts#L44) +Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts:44](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts#L44) A React hook that creates a debounced version of an async callback function. This hook is a convenient wrapper around the `useAsyncDebouncer` hook, @@ -50,7 +50,7 @@ Consider using the `useAsyncDebouncer` hook instead. ## Returns ```ts -(...args): Promise>; +(...args): Promise>>; ``` ### Parameters @@ -61,7 +61,7 @@ Consider using the `useAsyncDebouncer` hook instead. ### Returns -`Promise`\<`ReturnType`\<`TFn`\>\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\> ## Example diff --git a/docs/framework/react/reference/functions/useAsyncDebouncer.md b/docs/framework/react/reference/functions/useAsyncDebouncer.md index ca017f2f2..2dfa138a9 100644 --- a/docs/framework/react/reference/functions/useAsyncDebouncer.md +++ b/docs/framework/react/reference/functions/useAsyncDebouncer.md @@ -12,7 +12,7 @@ function useAsyncDebouncer( selector): ReactAsyncDebouncer; ``` -Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:214](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L214) +Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:214](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L214) A low-level React hook that creates an `AsyncDebouncer` instance to delay execution of an async function. diff --git a/docs/framework/react/reference/functions/useAsyncQueuedState.md b/docs/framework/react/reference/functions/useAsyncQueuedState.md index eff649391..038e977f8 100644 --- a/docs/framework/react/reference/functions/useAsyncQueuedState.md +++ b/docs/framework/react/reference/functions/useAsyncQueuedState.md @@ -12,7 +12,7 @@ function useAsyncQueuedState( selector?): [TValue[], ReactAsyncQueuer]; ``` -Defined in: [react-pacer/src/async-queuer/useAsyncQueuedState.ts:151](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuedState.ts#L151) +Defined in: [react-pacer/src/async-queuer/useAsyncQueuedState.ts:151](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuedState.ts#L151) A higher-level React hook that creates an `AsyncQueuer` instance with built-in state management. diff --git a/docs/framework/react/reference/functions/useAsyncQueuer.md b/docs/framework/react/reference/functions/useAsyncQueuer.md index acf5453bc..91f405134 100644 --- a/docs/framework/react/reference/functions/useAsyncQueuer.md +++ b/docs/framework/react/reference/functions/useAsyncQueuer.md @@ -12,7 +12,7 @@ function useAsyncQueuer( selector): ReactAsyncQueuer; ``` -Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:235](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L235) +Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:235](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L235) A lower-level React hook that creates an `AsyncQueuer` instance for managing an async queue of items. diff --git a/docs/framework/react/reference/functions/useAsyncRateLimitedCallback.md b/docs/framework/react/reference/functions/useAsyncRateLimitedCallback.md index 23bd706a8..b8c403c09 100644 --- a/docs/framework/react/reference/functions/useAsyncRateLimitedCallback.md +++ b/docs/framework/react/reference/functions/useAsyncRateLimitedCallback.md @@ -6,10 +6,10 @@ title: useAsyncRateLimitedCallback # Function: useAsyncRateLimitedCallback() ```ts -function useAsyncRateLimitedCallback(fn, options): (...args) => Promise>; +function useAsyncRateLimitedCallback(fn, options): (...args) => Promise>>; ``` -Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts:59](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts#L59) +Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts:59](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts#L59) A React hook that creates a rate-limited version of an async callback function. This hook is a convenient wrapper around the `useAsyncRateLimiter` hook, @@ -64,7 +64,7 @@ Consider using the `useAsyncRateLimiter` hook instead. ## Returns ```ts -(...args): Promise>; +(...args): Promise>>; ``` ### Parameters @@ -75,7 +75,7 @@ Consider using the `useAsyncRateLimiter` hook instead. ### Returns -`Promise`\<`ReturnType`\<`TFn`\>\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\> ## Example diff --git a/docs/framework/react/reference/functions/useAsyncRateLimiter.md b/docs/framework/react/reference/functions/useAsyncRateLimiter.md index 48c780baa..15261d389 100644 --- a/docs/framework/react/reference/functions/useAsyncRateLimiter.md +++ b/docs/framework/react/reference/functions/useAsyncRateLimiter.md @@ -12,7 +12,7 @@ function useAsyncRateLimiter( selector): ReactAsyncRateLimiter; ``` -Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:231](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L231) +Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:231](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L231) A low-level React hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window. diff --git a/docs/framework/react/reference/functions/useAsyncThrottledCallback.md b/docs/framework/react/reference/functions/useAsyncThrottledCallback.md index f8303ee8e..d737a4427 100644 --- a/docs/framework/react/reference/functions/useAsyncThrottledCallback.md +++ b/docs/framework/react/reference/functions/useAsyncThrottledCallback.md @@ -6,10 +6,10 @@ title: useAsyncThrottledCallback # Function: useAsyncThrottledCallback() ```ts -function useAsyncThrottledCallback(fn, options): (...args) => Promise>; +function useAsyncThrottledCallback(fn, options): (...args) => Promise>>; ``` -Defined in: [react-pacer/src/async-throttler/useAsyncThrottledCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottledCallback.ts#L42) +Defined in: [react-pacer/src/async-throttler/useAsyncThrottledCallback.ts:42](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottledCallback.ts#L42) A React hook that creates a throttled version of an async callback function. This hook is a convenient wrapper around the `useAsyncThrottler` hook, @@ -51,7 +51,7 @@ Consider using the `useAsyncThrottler` hook instead. ## Returns ```ts -(...args): Promise>; +(...args): Promise>>; ``` ### Parameters @@ -62,7 +62,7 @@ Consider using the `useAsyncThrottler` hook instead. ### Returns -`Promise`\<`ReturnType`\<`TFn`\>\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\>\> ## Example diff --git a/docs/framework/react/reference/functions/useAsyncThrottler.md b/docs/framework/react/reference/functions/useAsyncThrottler.md index 2c3e10318..4164dd315 100644 --- a/docs/framework/react/reference/functions/useAsyncThrottler.md +++ b/docs/framework/react/reference/functions/useAsyncThrottler.md @@ -12,7 +12,7 @@ function useAsyncThrottler( selector): ReactAsyncThrottler; ``` -Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:225](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L225) +Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:225](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L225) A low-level React hook that creates an `AsyncThrottler` instance to limit how often an async function can execute. diff --git a/docs/framework/react/reference/functions/useBatchedCallback.md b/docs/framework/react/reference/functions/useBatchedCallback.md index 67c2da2ce..4e3a89cf6 100644 --- a/docs/framework/react/reference/functions/useBatchedCallback.md +++ b/docs/framework/react/reference/functions/useBatchedCallback.md @@ -9,7 +9,7 @@ title: useBatchedCallback function useBatchedCallback(fn, options): (item) => void; ``` -Defined in: [react-pacer/src/batcher/useBatchedCallback.ts:40](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatchedCallback.ts#L40) +Defined in: [react-pacer/src/batcher/useBatchedCallback.ts:40](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/batcher/useBatchedCallback.ts#L40) A React hook that creates a batched version of a callback function. This hook is essentially a wrapper around the basic `batch` function diff --git a/docs/framework/react/reference/functions/useBatcher.md b/docs/framework/react/reference/functions/useBatcher.md index cf8ba7ba3..2fc0c43d1 100644 --- a/docs/framework/react/reference/functions/useBatcher.md +++ b/docs/framework/react/reference/functions/useBatcher.md @@ -12,7 +12,7 @@ function useBatcher( selector): ReactBatcher; ``` -Defined in: [react-pacer/src/batcher/useBatcher.ts:183](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L183) +Defined in: [react-pacer/src/batcher/useBatcher.ts:183](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L183) A React hook that creates and manages a Batcher instance. diff --git a/docs/framework/react/reference/functions/useDebouncedCallback.md b/docs/framework/react/reference/functions/useDebouncedCallback.md index 356f38973..408a0161a 100644 --- a/docs/framework/react/reference/functions/useDebouncedCallback.md +++ b/docs/framework/react/reference/functions/useDebouncedCallback.md @@ -9,7 +9,7 @@ title: useDebouncedCallback function useDebouncedCallback(fn, options): (...args) => void; ``` -Defined in: [react-pacer/src/debouncer/useDebouncedCallback.ts:42](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncedCallback.ts#L42) +Defined in: [react-pacer/src/debouncer/useDebouncedCallback.ts:42](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncedCallback.ts#L42) A React hook that creates a debounced version of a callback function. This hook is essentially a wrapper around the basic `debounce` function diff --git a/docs/framework/react/reference/functions/useDebouncedState.md b/docs/framework/react/reference/functions/useDebouncedState.md index 749f44190..60ddd8dd8 100644 --- a/docs/framework/react/reference/functions/useDebouncedState.md +++ b/docs/framework/react/reference/functions/useDebouncedState.md @@ -12,7 +12,7 @@ function useDebouncedState( selector?): [TValue, Dispatch>, ReactDebouncer>, TSelected>]; ``` -Defined in: [react-pacer/src/debouncer/useDebouncedState.ts:78](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncedState.ts#L78) +Defined in: [react-pacer/src/debouncer/useDebouncedState.ts:78](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncedState.ts#L78) A React hook that creates a debounced state value, combining React's useState with debouncing functionality. This hook provides both the current debounced value and methods to update it. diff --git a/docs/framework/react/reference/functions/useDebouncedValue.md b/docs/framework/react/reference/functions/useDebouncedValue.md index ca55bc22c..3fc56401f 100644 --- a/docs/framework/react/reference/functions/useDebouncedValue.md +++ b/docs/framework/react/reference/functions/useDebouncedValue.md @@ -12,7 +12,7 @@ function useDebouncedValue( selector?): [TValue, ReactDebouncer>, TSelected>]; ``` -Defined in: [react-pacer/src/debouncer/useDebouncedValue.ts:87](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncedValue.ts#L87) +Defined in: [react-pacer/src/debouncer/useDebouncedValue.ts:87](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncedValue.ts#L87) A React hook that creates a debounced value that updates only after a specified delay. Unlike useDebouncedState, this hook automatically tracks changes to the input value diff --git a/docs/framework/react/reference/functions/useDebouncer.md b/docs/framework/react/reference/functions/useDebouncer.md index a098fe842..0555dbdae 100644 --- a/docs/framework/react/reference/functions/useDebouncer.md +++ b/docs/framework/react/reference/functions/useDebouncer.md @@ -12,7 +12,7 @@ function useDebouncer( selector): ReactDebouncer; ``` -Defined in: [react-pacer/src/debouncer/useDebouncer.ts:163](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L163) +Defined in: [react-pacer/src/debouncer/useDebouncer.ts:163](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L163) A React hook that creates and manages a Debouncer instance. diff --git a/docs/framework/react/reference/functions/useDefaultPacerOptions.md b/docs/framework/react/reference/functions/useDefaultPacerOptions.md index 09bc4240a..aae6ce86b 100644 --- a/docs/framework/react/reference/functions/useDefaultPacerOptions.md +++ b/docs/framework/react/reference/functions/useDefaultPacerOptions.md @@ -9,7 +9,7 @@ title: useDefaultPacerOptions function useDefaultPacerOptions(): PacerProviderOptions; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:66](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L66) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:66](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L66) ## Returns diff --git a/docs/framework/react/reference/functions/usePacerContext.md b/docs/framework/react/reference/functions/usePacerContext.md index 43d1fd741..6ca57717a 100644 --- a/docs/framework/react/reference/functions/usePacerContext.md +++ b/docs/framework/react/reference/functions/usePacerContext.md @@ -9,7 +9,7 @@ title: usePacerContext function usePacerContext(): PacerContextValue | null; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:62](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L62) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:62](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L62) ## Returns diff --git a/docs/framework/react/reference/functions/useQueuedState.md b/docs/framework/react/reference/functions/useQueuedState.md index 0ee9fd75d..371d95975 100644 --- a/docs/framework/react/reference/functions/useQueuedState.md +++ b/docs/framework/react/reference/functions/useQueuedState.md @@ -12,7 +12,7 @@ function useQueuedState( selector?): [TValue[], (item, position?, runOnItemsChange?) => boolean, ReactQueuer]; ``` -Defined in: [react-pacer/src/queuer/useQueuedState.ts:119](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuedState.ts#L119) +Defined in: [react-pacer/src/queuer/useQueuedState.ts:119](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuedState.ts#L119) A React hook that creates a queuer with managed state, combining React's useState with queuing functionality. This hook provides both the current queue state and queue control methods. diff --git a/docs/framework/react/reference/functions/useQueuedValue.md b/docs/framework/react/reference/functions/useQueuedValue.md index 3d13dd696..0519c927e 100644 --- a/docs/framework/react/reference/functions/useQueuedValue.md +++ b/docs/framework/react/reference/functions/useQueuedValue.md @@ -12,7 +12,7 @@ function useQueuedValue( selector?): [TValue, ReactQueuer]; ``` -Defined in: [react-pacer/src/queuer/useQueuedValue.ts:103](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuedValue.ts#L103) +Defined in: [react-pacer/src/queuer/useQueuedValue.ts:103](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuedValue.ts#L103) A React hook that creates a queued value that processes state changes in order with an optional delay. This hook uses useQueuer internally to manage a queue of state changes and apply them sequentially. diff --git a/docs/framework/react/reference/functions/useQueuer.md b/docs/framework/react/reference/functions/useQueuer.md index da94837be..dbe18ba14 100644 --- a/docs/framework/react/reference/functions/useQueuer.md +++ b/docs/framework/react/reference/functions/useQueuer.md @@ -12,7 +12,7 @@ function useQueuer( selector): ReactQueuer; ``` -Defined in: [react-pacer/src/queuer/useQueuer.ts:194](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L194) +Defined in: [react-pacer/src/queuer/useQueuer.ts:194](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L194) A React hook that creates and manages a Queuer instance. diff --git a/docs/framework/react/reference/functions/useRateLimitedCallback.md b/docs/framework/react/reference/functions/useRateLimitedCallback.md index 74ed5cfc6..428d59bd0 100644 --- a/docs/framework/react/reference/functions/useRateLimitedCallback.md +++ b/docs/framework/react/reference/functions/useRateLimitedCallback.md @@ -9,7 +9,7 @@ title: useRateLimitedCallback function useRateLimitedCallback(fn, options): (...args) => boolean; ``` -Defined in: [react-pacer/src/rate-limiter/useRateLimitedCallback.ts:59](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimitedCallback.ts#L59) +Defined in: [react-pacer/src/rate-limiter/useRateLimitedCallback.ts:59](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimitedCallback.ts#L59) A React hook that creates a rate-limited version of a callback function. This hook is essentially a wrapper around the basic `rateLimiter` function diff --git a/docs/framework/react/reference/functions/useRateLimitedState.md b/docs/framework/react/reference/functions/useRateLimitedState.md index 9d79d6320..6cd8e559f 100644 --- a/docs/framework/react/reference/functions/useRateLimitedState.md +++ b/docs/framework/react/reference/functions/useRateLimitedState.md @@ -12,7 +12,7 @@ function useRateLimitedState( selector?): [TValue, Dispatch>, ReactRateLimiter>, TSelected>]; ``` -Defined in: [react-pacer/src/rate-limiter/useRateLimitedState.ts:107](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimitedState.ts#L107) +Defined in: [react-pacer/src/rate-limiter/useRateLimitedState.ts:107](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimitedState.ts#L107) A React hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window. This hook combines React's useState with rate limiting functionality to provide controlled state updates. diff --git a/docs/framework/react/reference/functions/useRateLimitedValue.md b/docs/framework/react/reference/functions/useRateLimitedValue.md index 822576ec9..a2f93b2c6 100644 --- a/docs/framework/react/reference/functions/useRateLimitedValue.md +++ b/docs/framework/react/reference/functions/useRateLimitedValue.md @@ -12,7 +12,7 @@ function useRateLimitedValue( selector?): [TValue, ReactRateLimiter>, TSelected>]; ``` -Defined in: [react-pacer/src/rate-limiter/useRateLimitedValue.ts:96](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimitedValue.ts#L96) +Defined in: [react-pacer/src/rate-limiter/useRateLimitedValue.ts:96](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimitedValue.ts#L96) A high-level React hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window. This hook uses React's useState internally to manage the rate-limited state. diff --git a/docs/framework/react/reference/functions/useRateLimiter.md b/docs/framework/react/reference/functions/useRateLimiter.md index b30fb8fc0..bb31f684b 100644 --- a/docs/framework/react/reference/functions/useRateLimiter.md +++ b/docs/framework/react/reference/functions/useRateLimiter.md @@ -12,7 +12,7 @@ function useRateLimiter( selector): ReactRateLimiter; ``` -Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:190](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L190) +Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:190](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L190) A low-level React hook that creates a `RateLimiter` instance to enforce rate limits on function execution. diff --git a/docs/framework/react/reference/functions/useThrottledCallback.md b/docs/framework/react/reference/functions/useThrottledCallback.md index ba1e842eb..7f0d8147c 100644 --- a/docs/framework/react/reference/functions/useThrottledCallback.md +++ b/docs/framework/react/reference/functions/useThrottledCallback.md @@ -9,7 +9,7 @@ title: useThrottledCallback function useThrottledCallback(fn, options): (...args) => void; ``` -Defined in: [react-pacer/src/throttler/useThrottledCallback.ts:43](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottledCallback.ts#L43) +Defined in: [react-pacer/src/throttler/useThrottledCallback.ts:43](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottledCallback.ts#L43) A React hook that creates a throttled version of a callback function. This hook is essentially a wrapper around the basic `throttle` function diff --git a/docs/framework/react/reference/functions/useThrottledState.md b/docs/framework/react/reference/functions/useThrottledState.md index fde279a04..8f885467b 100644 --- a/docs/framework/react/reference/functions/useThrottledState.md +++ b/docs/framework/react/reference/functions/useThrottledState.md @@ -12,7 +12,7 @@ function useThrottledState( selector?): [TValue, Dispatch>, ReactThrottler>, TSelected>]; ``` -Defined in: [react-pacer/src/throttler/useThrottledState.ts:90](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottledState.ts#L90) +Defined in: [react-pacer/src/throttler/useThrottledState.ts:90](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottledState.ts#L90) A React hook that creates a throttled state value that updates at most once within a specified time window. This hook combines React's useState with throttling functionality to provide controlled state updates. diff --git a/docs/framework/react/reference/functions/useThrottledValue.md b/docs/framework/react/reference/functions/useThrottledValue.md index c8dc84658..acda6cc16 100644 --- a/docs/framework/react/reference/functions/useThrottledValue.md +++ b/docs/framework/react/reference/functions/useThrottledValue.md @@ -12,7 +12,7 @@ function useThrottledValue( selector?): [TValue, ReactThrottler>, TSelected>]; ``` -Defined in: [react-pacer/src/throttler/useThrottledValue.ts:82](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottledValue.ts#L82) +Defined in: [react-pacer/src/throttler/useThrottledValue.ts:82](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottledValue.ts#L82) A high-level React hook that creates a throttled version of a value that updates at most once within a specified time window. This hook uses React's useState internally to manage the throttled state. diff --git a/docs/framework/react/reference/functions/useThrottler.md b/docs/framework/react/reference/functions/useThrottler.md index 08a31033b..f9cdaa1bc 100644 --- a/docs/framework/react/reference/functions/useThrottler.md +++ b/docs/framework/react/reference/functions/useThrottler.md @@ -12,7 +12,7 @@ function useThrottler( selector): ReactThrottler; ``` -Defined in: [react-pacer/src/throttler/useThrottler.ts:168](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L168) +Defined in: [react-pacer/src/throttler/useThrottler.ts:168](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L168) A low-level React hook that creates a `Throttler` instance that limits how often the provided function can execute. diff --git a/docs/framework/react/reference/interfaces/PacerProviderOptions.md b/docs/framework/react/reference/interfaces/PacerProviderOptions.md index 84d424094..67369cc37 100644 --- a/docs/framework/react/reference/interfaces/PacerProviderOptions.md +++ b/docs/framework/react/reference/interfaces/PacerProviderOptions.md @@ -5,7 +5,7 @@ title: PacerProviderOptions # Interface: PacerProviderOptions -Defined in: [react-pacer/src/provider/PacerProvider.tsx:18](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L18) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:18](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L18) ## Properties @@ -15,7 +15,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:18](https://github.com/T optional asyncBatcher: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:19](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L19) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:19](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L19) *** @@ -25,7 +25,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:19](https://github.com/T optional asyncDebouncer: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:20](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L20) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:20](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L20) *** @@ -35,7 +35,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:20](https://github.com/T optional asyncQueuer: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:21](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L21) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:21](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L21) *** @@ -45,7 +45,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:21](https://github.com/T optional asyncRateLimiter: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:22](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L22) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:22](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L22) *** @@ -55,7 +55,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:22](https://github.com/T optional asyncThrottler: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:23](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L23) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:23](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L23) *** @@ -65,7 +65,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:23](https://github.com/T optional batcher: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:24](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L24) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:24](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L24) *** @@ -75,7 +75,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:24](https://github.com/T optional debouncer: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:25](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L25) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:25](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L25) *** @@ -85,7 +85,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:25](https://github.com/T optional queuer: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:26](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L26) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:26](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L26) *** @@ -95,7 +95,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:26](https://github.com/T optional rateLimiter: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:27](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L27) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:27](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L27) *** @@ -105,4 +105,4 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:27](https://github.com/T optional throttler: Partial>; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:28](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L28) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:28](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L28) diff --git a/docs/framework/react/reference/interfaces/PacerProviderProps.md b/docs/framework/react/reference/interfaces/PacerProviderProps.md index 0876f5024..a1b6816b5 100644 --- a/docs/framework/react/reference/interfaces/PacerProviderProps.md +++ b/docs/framework/react/reference/interfaces/PacerProviderProps.md @@ -5,7 +5,7 @@ title: PacerProviderProps # Interface: PacerProviderProps -Defined in: [react-pacer/src/provider/PacerProvider.tsx:37](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L37) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:37](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L37) ## Properties @@ -15,7 +15,7 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:37](https://github.com/T children: ReactNode; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:38](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L38) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:38](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L38) *** @@ -25,4 +25,4 @@ Defined in: [react-pacer/src/provider/PacerProvider.tsx:38](https://github.com/T optional defaultOptions: PacerProviderOptions; ``` -Defined in: [react-pacer/src/provider/PacerProvider.tsx:39](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L39) +Defined in: [react-pacer/src/provider/PacerProvider.tsx:39](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/provider/PacerProvider.tsx#L39) diff --git a/docs/framework/react/reference/interfaces/ReactAsyncBatcher.md b/docs/framework/react/reference/interfaces/ReactAsyncBatcher.md index 688793372..f9c21f9c6 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncBatcher.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncBatcher.md @@ -5,7 +5,7 @@ title: ReactAsyncBatcher # Interface: ReactAsyncBatcher\ -Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:23](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L23) +Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:23](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L23) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:23](https://github readonly state: Readonly; ``` -Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:49](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L49) +Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:49](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L49) Reactive state that will be updated and re-rendered when the batcher state changes @@ -44,7 +44,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:55](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L55) +Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:55](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L55) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:40](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L40) +Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:40](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L40) A React HOC (Higher Order Component) that allows you to subscribe to the batcher state. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncBatcherOptions.md b/docs/framework/react/reference/interfaces/ReactAsyncBatcherOptions.md index b57d83c03..e8a4fc49b 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncBatcherOptions.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncBatcherOptions.md @@ -5,7 +5,7 @@ title: ReactAsyncBatcherOptions # Interface: ReactAsyncBatcherOptions\ -Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:12](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L12) +Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:12](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L12) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:12](https://github optional onUnmount: (batcher) => void; ``` -Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L20) +Defined in: [react-pacer/src/async-batcher/useAsyncBatcher.ts:20](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-batcher/useAsyncBatcher.ts#L20) Optional callback invoked when the component unmounts. Receives the batcher instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncDebouncer.md b/docs/framework/react/reference/interfaces/ReactAsyncDebouncer.md index 1730660f1..f1e498166 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncDebouncer.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncDebouncer.md @@ -5,7 +5,7 @@ title: ReactAsyncDebouncer # Interface: ReactAsyncDebouncer\ -Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L24) +Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:24](https://gi readonly state: Readonly; ``` -Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:50](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L50) +Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:50](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L50) Reactive state that will be updated and re-rendered when the debouncer state changes @@ -44,7 +44,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:56](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L56) +Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:56](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L41) +Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:41](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L41) A React HOC (Higher Order Component) that allows you to subscribe to the debouncer state. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncDebouncerOptions.md b/docs/framework/react/reference/interfaces/ReactAsyncDebouncerOptions.md index c768de01e..da4ef95fa 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncDebouncerOptions.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncDebouncerOptions.md @@ -5,7 +5,7 @@ title: ReactAsyncDebouncerOptions # Interface: ReactAsyncDebouncerOptions\ -Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L13) +Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:13](https://gi optional onUnmount: (debouncer) => void; ``` -Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L21) +Defined in: [react-pacer/src/async-debouncer/useAsyncDebouncer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-debouncer/useAsyncDebouncer.ts#L21) Optional callback invoked when the component unmounts. Receives the debouncer instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncQueuer.md b/docs/framework/react/reference/interfaces/ReactAsyncQueuer.md index 2545dd253..f41f06c65 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncQueuer.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncQueuer.md @@ -5,7 +5,7 @@ title: ReactAsyncQueuer # Interface: ReactAsyncQueuer\ -Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:23](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L23) +Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:23](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L23) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:23](https://github.c readonly state: Readonly; ``` -Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:49](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L49) +Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:49](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L49) Reactive state that will be updated and re-rendered when the queuer state changes @@ -44,7 +44,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:55](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L55) +Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:55](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L55) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:40](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L40) +Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:40](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L40) A React HOC (Higher Order Component) that allows you to subscribe to the queuer state. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncQueuerOptions.md b/docs/framework/react/reference/interfaces/ReactAsyncQueuerOptions.md index cbd48e17f..f7a7327a8 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncQueuerOptions.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncQueuerOptions.md @@ -5,7 +5,7 @@ title: ReactAsyncQueuerOptions # Interface: ReactAsyncQueuerOptions\ -Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:12](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L12) +Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:12](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L12) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:12](https://github.c optional onUnmount: (queuer) => void; ``` -Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L20) +Defined in: [react-pacer/src/async-queuer/useAsyncQueuer.ts:20](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-queuer/useAsyncQueuer.ts#L20) Optional callback invoked when the component unmounts. Receives the queuer instance. When provided, replaces the default cleanup (stop + abort); use it to call flush(), flushAsBatch(), stop(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncRateLimiter.md b/docs/framework/react/reference/interfaces/ReactAsyncRateLimiter.md index 9e1a62a67..9bb64d32d 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncRateLimiter.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncRateLimiter.md @@ -5,7 +5,7 @@ title: ReactAsyncRateLimiter # Interface: ReactAsyncRateLimiter\ -Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:24](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L24) +Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:24](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:24](https readonly state: Readonly; ``` -Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:50](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L50) +Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:50](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L50) Reactive state that will be updated and re-rendered when the rate limiter state changes @@ -44,7 +44,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:56](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L56) +Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:56](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:41](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L41) +Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:41](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L41) A React HOC (Higher Order Component) that allows you to subscribe to the rate limiter state. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncRateLimiterOptions.md b/docs/framework/react/reference/interfaces/ReactAsyncRateLimiterOptions.md index 23e6a994c..f3630058c 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncRateLimiterOptions.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncRateLimiterOptions.md @@ -5,7 +5,7 @@ title: ReactAsyncRateLimiterOptions # Interface: ReactAsyncRateLimiterOptions\ -Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L13) +Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:13](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:13](https optional onUnmount: (rateLimiter) => void; ``` -Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L21) +Defined in: [react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:21](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts#L21) Optional callback invoked when the component unmounts. Receives the rate limiter instance. When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncThrottler.md b/docs/framework/react/reference/interfaces/ReactAsyncThrottler.md index 6da2b68ba..48f2cd5ce 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncThrottler.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncThrottler.md @@ -5,7 +5,7 @@ title: ReactAsyncThrottler # Interface: ReactAsyncThrottler\ -Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L24) +Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:24](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:24](https://gi readonly state: Readonly; ``` -Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:50](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L50) +Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:50](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L50) Reactive state that will be updated and re-rendered when the throttler state changes @@ -44,7 +44,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:56](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L56) +Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:56](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:41](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L41) +Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:41](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L41) A React HOC (Higher Order Component) that allows you to subscribe to the throttler state. diff --git a/docs/framework/react/reference/interfaces/ReactAsyncThrottlerOptions.md b/docs/framework/react/reference/interfaces/ReactAsyncThrottlerOptions.md index 7acf62c11..ac67e88f7 100644 --- a/docs/framework/react/reference/interfaces/ReactAsyncThrottlerOptions.md +++ b/docs/framework/react/reference/interfaces/ReactAsyncThrottlerOptions.md @@ -5,7 +5,7 @@ title: ReactAsyncThrottlerOptions # Interface: ReactAsyncThrottlerOptions\ -Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L13) +Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:13](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:13](https://gi optional onUnmount: (throttler) => void; ``` -Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L21) +Defined in: [react-pacer/src/async-throttler/useAsyncThrottler.ts:21](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/async-throttler/useAsyncThrottler.ts#L21) Optional callback invoked when the component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactBatcher.md b/docs/framework/react/reference/interfaces/ReactBatcher.md index 74b65b564..a7eecebd1 100644 --- a/docs/framework/react/reference/interfaces/ReactBatcher.md +++ b/docs/framework/react/reference/interfaces/ReactBatcher.md @@ -5,7 +5,7 @@ title: ReactBatcher # Interface: ReactBatcher\ -Defined in: [react-pacer/src/batcher/useBatcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L20) +Defined in: [react-pacer/src/batcher/useBatcher.ts:20](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L20) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/batcher/useBatcher.ts:20](https://github.com/TanSta readonly state: Readonly; ``` -Defined in: [react-pacer/src/batcher/useBatcher.ts:46](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L46) +Defined in: [react-pacer/src/batcher/useBatcher.ts:46](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L46) Reactive state that will be updated and re-rendered when the batcher state changes @@ -44,7 +44,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/batcher/useBatcher.ts:52](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L52) +Defined in: [react-pacer/src/batcher/useBatcher.ts:52](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L52) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/batcher/useBatcher.ts:37](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L37) +Defined in: [react-pacer/src/batcher/useBatcher.ts:37](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L37) A React HOC (Higher Order Component) that allows you to subscribe to the batcher state. diff --git a/docs/framework/react/reference/interfaces/ReactBatcherOptions.md b/docs/framework/react/reference/interfaces/ReactBatcherOptions.md index ca406e175..ed9f38e48 100644 --- a/docs/framework/react/reference/interfaces/ReactBatcherOptions.md +++ b/docs/framework/react/reference/interfaces/ReactBatcherOptions.md @@ -5,7 +5,7 @@ title: ReactBatcherOptions # Interface: ReactBatcherOptions\ -Defined in: [react-pacer/src/batcher/useBatcher.ts:9](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L9) +Defined in: [react-pacer/src/batcher/useBatcher.ts:9](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L9) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/batcher/useBatcher.ts:9](https://github.com/TanStac optional onUnmount: (batcher) => void; ``` -Defined in: [react-pacer/src/batcher/useBatcher.ts:17](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L17) +Defined in: [react-pacer/src/batcher/useBatcher.ts:17](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/batcher/useBatcher.ts#L17) Optional callback invoked when the component unmounts. Receives the batcher instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactDebouncer.md b/docs/framework/react/reference/interfaces/ReactDebouncer.md index 1bdfe1626..c57befed3 100644 --- a/docs/framework/react/reference/interfaces/ReactDebouncer.md +++ b/docs/framework/react/reference/interfaces/ReactDebouncer.md @@ -5,7 +5,7 @@ title: ReactDebouncer # Interface: ReactDebouncer\ -Defined in: [react-pacer/src/debouncer/useDebouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L24) +Defined in: [react-pacer/src/debouncer/useDebouncer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/debouncer/useDebouncer.ts:24](https://github.com/Ta readonly state: Readonly; ``` -Defined in: [react-pacer/src/debouncer/useDebouncer.ts:50](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L50) +Defined in: [react-pacer/src/debouncer/useDebouncer.ts:50](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L50) Reactive state that will be updated and re-rendered when the debouncer state changes @@ -44,7 +44,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/debouncer/useDebouncer.ts:56](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L56) +Defined in: [react-pacer/src/debouncer/useDebouncer.ts:56](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/debouncer/useDebouncer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L41) +Defined in: [react-pacer/src/debouncer/useDebouncer.ts:41](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L41) A React HOC (Higher Order Component) that allows you to subscribe to the debouncer state. diff --git a/docs/framework/react/reference/interfaces/ReactDebouncerOptions.md b/docs/framework/react/reference/interfaces/ReactDebouncerOptions.md index 6ef1d0880..95384560d 100644 --- a/docs/framework/react/reference/interfaces/ReactDebouncerOptions.md +++ b/docs/framework/react/reference/interfaces/ReactDebouncerOptions.md @@ -5,7 +5,7 @@ title: ReactDebouncerOptions # Interface: ReactDebouncerOptions\ -Defined in: [react-pacer/src/debouncer/useDebouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L13) +Defined in: [react-pacer/src/debouncer/useDebouncer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/debouncer/useDebouncer.ts:13](https://github.com/Ta optional onUnmount: (debouncer) => void; ``` -Defined in: [react-pacer/src/debouncer/useDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L21) +Defined in: [react-pacer/src/debouncer/useDebouncer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/debouncer/useDebouncer.ts#L21) Optional callback invoked when the component unmounts. Receives the debouncer instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactQueuer.md b/docs/framework/react/reference/interfaces/ReactQueuer.md index 31e31bfbe..62b2c7e54 100644 --- a/docs/framework/react/reference/interfaces/ReactQueuer.md +++ b/docs/framework/react/reference/interfaces/ReactQueuer.md @@ -5,7 +5,7 @@ title: ReactQueuer # Interface: ReactQueuer\ -Defined in: [react-pacer/src/queuer/useQueuer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L20) +Defined in: [react-pacer/src/queuer/useQueuer.ts:20](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L20) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/queuer/useQueuer.ts:20](https://github.com/TanStack readonly state: Readonly; ``` -Defined in: [react-pacer/src/queuer/useQueuer.ts:46](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L46) +Defined in: [react-pacer/src/queuer/useQueuer.ts:46](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L46) Reactive state that will be updated and re-rendered when the queuer state changes @@ -44,7 +44,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/queuer/useQueuer.ts:52](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L52) +Defined in: [react-pacer/src/queuer/useQueuer.ts:52](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L52) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/queuer/useQueuer.ts:37](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L37) +Defined in: [react-pacer/src/queuer/useQueuer.ts:37](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L37) A React HOC (Higher Order Component) that allows you to subscribe to the queuer state. diff --git a/docs/framework/react/reference/interfaces/ReactQueuerOptions.md b/docs/framework/react/reference/interfaces/ReactQueuerOptions.md index c80d696f6..03165e2fd 100644 --- a/docs/framework/react/reference/interfaces/ReactQueuerOptions.md +++ b/docs/framework/react/reference/interfaces/ReactQueuerOptions.md @@ -5,7 +5,7 @@ title: ReactQueuerOptions # Interface: ReactQueuerOptions\ -Defined in: [react-pacer/src/queuer/useQueuer.ts:9](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L9) +Defined in: [react-pacer/src/queuer/useQueuer.ts:9](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L9) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/queuer/useQueuer.ts:9](https://github.com/TanStack/ optional onUnmount: (queuer) => void; ``` -Defined in: [react-pacer/src/queuer/useQueuer.ts:17](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L17) +Defined in: [react-pacer/src/queuer/useQueuer.ts:17](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/queuer/useQueuer.ts#L17) Optional callback invoked when the component unmounts. Receives the queuer instance. When provided, replaces the default cleanup (stop); use it to call flush(), flushAsBatch(), stop(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactRateLimiter.md b/docs/framework/react/reference/interfaces/ReactRateLimiter.md index c952c7ced..1cef96fb5 100644 --- a/docs/framework/react/reference/interfaces/ReactRateLimiter.md +++ b/docs/framework/react/reference/interfaces/ReactRateLimiter.md @@ -5,7 +5,7 @@ title: ReactRateLimiter # Interface: ReactRateLimiter\ -Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:24](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L24) +Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:24](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:24](https://github.c readonly state: Readonly; ``` -Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:50](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L50) +Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:50](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L50) Reactive state that will be updated and re-rendered when the rate limiter state changes @@ -44,7 +44,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>; ``` -Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:56](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L56) +Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:56](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:41](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L41) +Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:41](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L41) A React HOC (Higher Order Component) that allows you to subscribe to the rate limiter state. diff --git a/docs/framework/react/reference/interfaces/ReactRateLimiterOptions.md b/docs/framework/react/reference/interfaces/ReactRateLimiterOptions.md index 5b4d341d4..b7ad93c9b 100644 --- a/docs/framework/react/reference/interfaces/ReactRateLimiterOptions.md +++ b/docs/framework/react/reference/interfaces/ReactRateLimiterOptions.md @@ -5,7 +5,7 @@ title: ReactRateLimiterOptions # Interface: ReactRateLimiterOptions\ -Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L13) +Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:13](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:13](https://github.c optional onUnmount: (rateLimiter) => void; ``` -Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L21) +Defined in: [react-pacer/src/rate-limiter/useRateLimiter.ts:21](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/rate-limiter/useRateLimiter.ts#L21) Optional callback invoked when the component unmounts. Receives the rate limiter instance. When provided, replaces the default cleanup; use it to call reset(), add logging, etc. diff --git a/docs/framework/react/reference/interfaces/ReactThrottler.md b/docs/framework/react/reference/interfaces/ReactThrottler.md index fba421705..0eacfe7c2 100644 --- a/docs/framework/react/reference/interfaces/ReactThrottler.md +++ b/docs/framework/react/reference/interfaces/ReactThrottler.md @@ -5,7 +5,7 @@ title: ReactThrottler # Interface: ReactThrottler\ -Defined in: [react-pacer/src/throttler/useThrottler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L24) +Defined in: [react-pacer/src/throttler/useThrottler.ts:24](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/throttler/useThrottler.ts:24](https://github.com/Ta readonly state: Readonly; ``` -Defined in: [react-pacer/src/throttler/useThrottler.ts:50](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L50) +Defined in: [react-pacer/src/throttler/useThrottler.ts:50](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L50) Reactive state that will be updated and re-rendered when the throttler state changes @@ -44,7 +44,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [react-pacer/src/throttler/useThrottler.ts:56](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L56) +Defined in: [react-pacer/src/throttler/useThrottler.ts:56](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => ReactNode | Promise; ``` -Defined in: [react-pacer/src/throttler/useThrottler.ts:41](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L41) +Defined in: [react-pacer/src/throttler/useThrottler.ts:41](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L41) A React HOC (Higher Order Component) that allows you to subscribe to the throttler state. diff --git a/docs/framework/react/reference/interfaces/ReactThrottlerOptions.md b/docs/framework/react/reference/interfaces/ReactThrottlerOptions.md index 692ad3c71..376b02763 100644 --- a/docs/framework/react/reference/interfaces/ReactThrottlerOptions.md +++ b/docs/framework/react/reference/interfaces/ReactThrottlerOptions.md @@ -5,7 +5,7 @@ title: ReactThrottlerOptions # Interface: ReactThrottlerOptions\ -Defined in: [react-pacer/src/throttler/useThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L13) +Defined in: [react-pacer/src/throttler/useThrottler.ts:13](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [react-pacer/src/throttler/useThrottler.ts:13](https://github.com/Ta optional onUnmount: (throttler) => void; ``` -Defined in: [react-pacer/src/throttler/useThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L21) +Defined in: [react-pacer/src/throttler/useThrottler.ts:21](https://github.com/ghostd/pacer/blob/main/packages/react-pacer/src/throttler/useThrottler.ts#L21) Optional callback invoked when the component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/functions/PacerProvider.md b/docs/framework/solid/reference/functions/PacerProvider.md index 7787e94ce..64b72ed7a 100644 --- a/docs/framework/solid/reference/functions/PacerProvider.md +++ b/docs/framework/solid/reference/functions/PacerProvider.md @@ -9,7 +9,7 @@ title: PacerProvider function PacerProvider(props): Element; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:44](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L44) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:44](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L44) ## Parameters diff --git a/docs/framework/solid/reference/functions/createAsyncBatcher.md b/docs/framework/solid/reference/functions/createAsyncBatcher.md index 15b2a884c..87da27b62 100644 --- a/docs/framework/solid/reference/functions/createAsyncBatcher.md +++ b/docs/framework/solid/reference/functions/createAsyncBatcher.md @@ -12,7 +12,7 @@ function createAsyncBatcher( selector): SolidAsyncBatcher; ``` -Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:189](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L189) +Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:189](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L189) Creates a Solid-compatible AsyncBatcher instance for managing asynchronous batches of items, exposing Solid signals for all stateful properties. diff --git a/docs/framework/solid/reference/functions/createAsyncDebouncer.md b/docs/framework/solid/reference/functions/createAsyncDebouncer.md index d8f8d115d..af35ab9b0 100644 --- a/docs/framework/solid/reference/functions/createAsyncDebouncer.md +++ b/docs/framework/solid/reference/functions/createAsyncDebouncer.md @@ -12,7 +12,7 @@ function createAsyncDebouncer( selector): SolidAsyncDebouncer; ``` -Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:175](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L175) +Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:175](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L175) A low-level Solid hook that creates an `AsyncDebouncer` instance to delay execution of an async function. diff --git a/docs/framework/solid/reference/functions/createAsyncQueuer.md b/docs/framework/solid/reference/functions/createAsyncQueuer.md index 2a8fb375b..3f0aacea8 100644 --- a/docs/framework/solid/reference/functions/createAsyncQueuer.md +++ b/docs/framework/solid/reference/functions/createAsyncQueuer.md @@ -12,7 +12,7 @@ function createAsyncQueuer( selector): SolidAsyncQueuer; ``` -Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:181](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L181) +Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:181](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L181) Creates a Solid-compatible AsyncQueuer instance for managing an asynchronous queue of items, exposing Solid signals for all stateful properties. diff --git a/docs/framework/solid/reference/functions/createAsyncRateLimiter.md b/docs/framework/solid/reference/functions/createAsyncRateLimiter.md index bde4d7fda..b3b4d7c45 100644 --- a/docs/framework/solid/reference/functions/createAsyncRateLimiter.md +++ b/docs/framework/solid/reference/functions/createAsyncRateLimiter.md @@ -12,7 +12,7 @@ function createAsyncRateLimiter( selector): SolidAsyncRateLimiter; ``` -Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:220](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L220) +Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:220](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L220) A low-level Solid hook that creates an `AsyncRateLimiter` instance to limit how many times an async function can execute within a time window. diff --git a/docs/framework/solid/reference/functions/createAsyncThrottler.md b/docs/framework/solid/reference/functions/createAsyncThrottler.md index 89acbda95..cfa5fcd8d 100644 --- a/docs/framework/solid/reference/functions/createAsyncThrottler.md +++ b/docs/framework/solid/reference/functions/createAsyncThrottler.md @@ -12,7 +12,7 @@ function createAsyncThrottler( selector): SolidAsyncThrottler; ``` -Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:175](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L175) +Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:175](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L175) A low-level Solid hook that creates an `AsyncThrottler` instance to limit how often an async function can execute. diff --git a/docs/framework/solid/reference/functions/createBatcher.md b/docs/framework/solid/reference/functions/createBatcher.md index 94215c3b3..46e16ecb0 100644 --- a/docs/framework/solid/reference/functions/createBatcher.md +++ b/docs/framework/solid/reference/functions/createBatcher.md @@ -12,7 +12,7 @@ function createBatcher( selector): SolidBatcher; ``` -Defined in: [solid-pacer/src/batcher/createBatcher.ts:155](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L155) +Defined in: [solid-pacer/src/batcher/createBatcher.ts:155](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L155) Creates a Solid-compatible Batcher instance for managing batches of items, exposing Solid signals for all stateful properties. diff --git a/docs/framework/solid/reference/functions/createDebouncedSignal.md b/docs/framework/solid/reference/functions/createDebouncedSignal.md index 685faca8a..2d36a1bd3 100644 --- a/docs/framework/solid/reference/functions/createDebouncedSignal.md +++ b/docs/framework/solid/reference/functions/createDebouncedSignal.md @@ -12,7 +12,7 @@ function createDebouncedSignal( selector?): [Accessor, Setter, SolidDebouncer, TSelected>]; ``` -Defined in: [solid-pacer/src/debouncer/createDebouncedSignal.ts:78](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncedSignal.ts#L78) +Defined in: [solid-pacer/src/debouncer/createDebouncedSignal.ts:78](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncedSignal.ts#L78) A Solid hook that creates a debounced state value, combining Solid's createSignal with debouncing functionality. This hook provides both the current debounced value and methods to update it. diff --git a/docs/framework/solid/reference/functions/createDebouncedValue.md b/docs/framework/solid/reference/functions/createDebouncedValue.md index b0a69fe30..019a82f80 100644 --- a/docs/framework/solid/reference/functions/createDebouncedValue.md +++ b/docs/framework/solid/reference/functions/createDebouncedValue.md @@ -12,7 +12,7 @@ function createDebouncedValue( selector?): [Accessor, SolidDebouncer, TSelected>]; ``` -Defined in: [solid-pacer/src/debouncer/createDebouncedValue.ts:69](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncedValue.ts#L69) +Defined in: [solid-pacer/src/debouncer/createDebouncedValue.ts:69](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncedValue.ts#L69) A Solid hook that creates a debounced value that updates only after a specified delay. Unlike createDebouncedSignal, this hook automatically tracks changes to the input value diff --git a/docs/framework/solid/reference/functions/createDebouncer.md b/docs/framework/solid/reference/functions/createDebouncer.md index d711c0e18..73b39fdec 100644 --- a/docs/framework/solid/reference/functions/createDebouncer.md +++ b/docs/framework/solid/reference/functions/createDebouncer.md @@ -12,7 +12,7 @@ function createDebouncer( selector): SolidDebouncer; ``` -Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:156](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L156) +Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:156](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L156) A Solid hook that creates and manages a Debouncer instance. diff --git a/docs/framework/solid/reference/functions/createQueuedSignal.md b/docs/framework/solid/reference/functions/createQueuedSignal.md index f5fd4a8bb..43df684d2 100644 --- a/docs/framework/solid/reference/functions/createQueuedSignal.md +++ b/docs/framework/solid/reference/functions/createQueuedSignal.md @@ -12,7 +12,7 @@ function createQueuedSignal( selector): [() => TValue[], (item, position?, runOnItemsChange?) => boolean, SolidQueuer]; ``` -Defined in: [solid-pacer/src/queuer/createQueuedSignal.ts:119](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuedSignal.ts#L119) +Defined in: [solid-pacer/src/queuer/createQueuedSignal.ts:119](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuedSignal.ts#L119) A Solid primitive that creates a queuer with managed state, combining Solid's signals with queuing functionality. This primitive provides both the current queue state and queue control methods. diff --git a/docs/framework/solid/reference/functions/createQueuer.md b/docs/framework/solid/reference/functions/createQueuer.md index 745c453e3..0df901eb2 100644 --- a/docs/framework/solid/reference/functions/createQueuer.md +++ b/docs/framework/solid/reference/functions/createQueuer.md @@ -12,7 +12,7 @@ function createQueuer( selector): SolidQueuer; ``` -Defined in: [solid-pacer/src/queuer/createQueuer.ts:156](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L156) +Defined in: [solid-pacer/src/queuer/createQueuer.ts:156](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L156) Creates a Solid-compatible Queuer instance for managing a synchronous queue of items, exposing Solid signals for all stateful properties. diff --git a/docs/framework/solid/reference/functions/createRateLimitedSignal.md b/docs/framework/solid/reference/functions/createRateLimitedSignal.md index 378d5de26..1ad415a94 100644 --- a/docs/framework/solid/reference/functions/createRateLimitedSignal.md +++ b/docs/framework/solid/reference/functions/createRateLimitedSignal.md @@ -12,7 +12,7 @@ function createRateLimitedSignal( selector?): [Accessor, Setter, SolidRateLimiter, TSelected>]; ``` -Defined in: [solid-pacer/src/rate-limiter/createRateLimitedSignal.ts:95](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimitedSignal.ts#L95) +Defined in: [solid-pacer/src/rate-limiter/createRateLimitedSignal.ts:95](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimitedSignal.ts#L95) A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window. This hook combines Solid's createSignal with rate limiting functionality to provide controlled state updates. diff --git a/docs/framework/solid/reference/functions/createRateLimitedValue.md b/docs/framework/solid/reference/functions/createRateLimitedValue.md index bb9014e71..c7dc61980 100644 --- a/docs/framework/solid/reference/functions/createRateLimitedValue.md +++ b/docs/framework/solid/reference/functions/createRateLimitedValue.md @@ -12,7 +12,7 @@ function createRateLimitedValue( selector?): [Accessor, SolidRateLimiter, TSelected>]; ``` -Defined in: [solid-pacer/src/rate-limiter/createRateLimitedValue.ts:97](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimitedValue.ts#L97) +Defined in: [solid-pacer/src/rate-limiter/createRateLimitedValue.ts:97](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimitedValue.ts#L97) A high-level Solid hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window. This hook uses Solid's createSignal internally to manage the rate-limited state. diff --git a/docs/framework/solid/reference/functions/createRateLimiter.md b/docs/framework/solid/reference/functions/createRateLimiter.md index 7698cb9f2..580583e05 100644 --- a/docs/framework/solid/reference/functions/createRateLimiter.md +++ b/docs/framework/solid/reference/functions/createRateLimiter.md @@ -12,7 +12,7 @@ function createRateLimiter( selector): SolidRateLimiter; ``` -Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:185](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L185) +Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:185](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L185) A low-level Solid hook that creates a `RateLimiter` instance to enforce rate limits on function execution. diff --git a/docs/framework/solid/reference/functions/createThrottledSignal.md b/docs/framework/solid/reference/functions/createThrottledSignal.md index a1e74840b..9cdb07c4b 100644 --- a/docs/framework/solid/reference/functions/createThrottledSignal.md +++ b/docs/framework/solid/reference/functions/createThrottledSignal.md @@ -12,7 +12,7 @@ function createThrottledSignal( selector?): [Accessor, Setter, SolidThrottler, TSelected>]; ``` -Defined in: [solid-pacer/src/throttler/createThrottledSignal.ts:69](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottledSignal.ts#L69) +Defined in: [solid-pacer/src/throttler/createThrottledSignal.ts:69](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottledSignal.ts#L69) A Solid hook that creates a throttled state value that updates at most once within a specified time window. This hook combines Solid's createSignal with throttling functionality to provide controlled state updates. diff --git a/docs/framework/solid/reference/functions/createThrottledValue.md b/docs/framework/solid/reference/functions/createThrottledValue.md index e7210acdc..f2e91e282 100644 --- a/docs/framework/solid/reference/functions/createThrottledValue.md +++ b/docs/framework/solid/reference/functions/createThrottledValue.md @@ -12,7 +12,7 @@ function createThrottledValue( selector?): [Accessor, SolidThrottler, TSelected>]; ``` -Defined in: [solid-pacer/src/throttler/createThrottledValue.ts:66](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottledValue.ts#L66) +Defined in: [solid-pacer/src/throttler/createThrottledValue.ts:66](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottledValue.ts#L66) A high-level Solid hook that creates a throttled version of a value that updates at most once within a specified time window. This hook uses Solid's createSignal internally to manage the throttled state. diff --git a/docs/framework/solid/reference/functions/createThrottler.md b/docs/framework/solid/reference/functions/createThrottler.md index 9956a9454..ed8eb84fe 100644 --- a/docs/framework/solid/reference/functions/createThrottler.md +++ b/docs/framework/solid/reference/functions/createThrottler.md @@ -12,7 +12,7 @@ function createThrottler( selector): SolidThrottler; ``` -Defined in: [solid-pacer/src/throttler/createThrottler.ts:159](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L159) +Defined in: [solid-pacer/src/throttler/createThrottler.ts:159](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L159) A low-level Solid hook that creates a `Throttler` instance that limits how often the provided function can execute. diff --git a/docs/framework/solid/reference/functions/useDefaultPacerOptions.md b/docs/framework/solid/reference/functions/useDefaultPacerOptions.md index f13948c38..cf80d6c34 100644 --- a/docs/framework/solid/reference/functions/useDefaultPacerOptions.md +++ b/docs/framework/solid/reference/functions/useDefaultPacerOptions.md @@ -9,7 +9,7 @@ title: useDefaultPacerOptions function useDefaultPacerOptions(): PacerProviderOptions; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:60](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L60) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:60](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L60) ## Returns diff --git a/docs/framework/solid/reference/functions/usePacerContext.md b/docs/framework/solid/reference/functions/usePacerContext.md index 12ef5ce1e..cf7e6b92d 100644 --- a/docs/framework/solid/reference/functions/usePacerContext.md +++ b/docs/framework/solid/reference/functions/usePacerContext.md @@ -9,7 +9,7 @@ title: usePacerContext function usePacerContext(): PacerContextValue | null; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:56](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L56) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:56](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L56) ## Returns diff --git a/docs/framework/solid/reference/interfaces/PacerProviderOptions.md b/docs/framework/solid/reference/interfaces/PacerProviderOptions.md index b0b791710..239e3471e 100644 --- a/docs/framework/solid/reference/interfaces/PacerProviderOptions.md +++ b/docs/framework/solid/reference/interfaces/PacerProviderOptions.md @@ -5,7 +5,7 @@ title: PacerProviderOptions # Interface: PacerProviderOptions -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:18](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L18) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:18](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L18) ## Properties @@ -15,7 +15,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:18](https://github.com/T optional asyncBatcher: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:19](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L19) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:19](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L19) *** @@ -25,7 +25,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:19](https://github.com/T optional asyncDebouncer: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:20](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L20) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:20](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L20) *** @@ -35,7 +35,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:20](https://github.com/T optional asyncQueuer: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L21) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:21](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L21) *** @@ -45,7 +45,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:21](https://github.com/T optional asyncRateLimiter: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:22](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L22) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:22](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L22) *** @@ -55,7 +55,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:22](https://github.com/T optional asyncThrottler: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L23) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:23](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L23) *** @@ -65,7 +65,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:23](https://github.com/T optional batcher: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:24](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L24) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:24](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L24) *** @@ -75,7 +75,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:24](https://github.com/T optional debouncer: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:25](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L25) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:25](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L25) *** @@ -85,7 +85,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:25](https://github.com/T optional queuer: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:26](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L26) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:26](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L26) *** @@ -95,7 +95,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:26](https://github.com/T optional rateLimiter: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:27](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L27) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:27](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L27) *** @@ -105,4 +105,4 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:27](https://github.com/T optional throttler: Partial>; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:28](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L28) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:28](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L28) diff --git a/docs/framework/solid/reference/interfaces/PacerProviderProps.md b/docs/framework/solid/reference/interfaces/PacerProviderProps.md index e28eb225e..ba955ed4d 100644 --- a/docs/framework/solid/reference/interfaces/PacerProviderProps.md +++ b/docs/framework/solid/reference/interfaces/PacerProviderProps.md @@ -5,7 +5,7 @@ title: PacerProviderProps # Interface: PacerProviderProps -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:37](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L37) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:37](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L37) ## Properties @@ -15,7 +15,7 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:37](https://github.com/T children: Element; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:38](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L38) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:38](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L38) *** @@ -25,4 +25,4 @@ Defined in: [solid-pacer/src/provider/PacerProvider.tsx:38](https://github.com/T optional defaultOptions: PacerProviderOptions; ``` -Defined in: [solid-pacer/src/provider/PacerProvider.tsx:39](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L39) +Defined in: [solid-pacer/src/provider/PacerProvider.tsx:39](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/provider/PacerProvider.tsx#L39) diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md b/docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md index b0bf2ca1a..16545945f 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncBatcher.md @@ -5,7 +5,7 @@ title: SolidAsyncBatcher # Interface: SolidAsyncBatcher\ -Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L23) +Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:23](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L23) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:23](https://git readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:49](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L49) +Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:49](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L49) Reactive state that will be updated when the batcher state changes @@ -44,7 +44,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:55](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L55) +Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:55](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L55) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:40](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L40) +Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:40](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L40) A Solid component that allows you to subscribe to the batcher state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncBatcherOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncBatcherOptions.md index 15be08bf8..0052d4b47 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncBatcherOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncBatcherOptions.md @@ -5,7 +5,7 @@ title: SolidAsyncBatcherOptions # Interface: SolidAsyncBatcherOptions\ -Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:12](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L12) +Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:12](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L12) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:12](https://git optional onUnmount: (batcher) => void; ``` -Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L20) +Defined in: [solid-pacer/src/async-batcher/createAsyncBatcher.ts:20](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-batcher/createAsyncBatcher.ts#L20) Optional callback invoked when the owning component unmounts. Receives the batcher instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md b/docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md index 68535f7e8..0728eafbc 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncDebouncer.md @@ -5,7 +5,7 @@ title: SolidAsyncDebouncer # Interface: SolidAsyncDebouncer\ -Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L24) +Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:24](https:/ readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:50](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L50) +Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:50](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L50) Reactive state that will be updated when the debouncer state changes @@ -44,7 +44,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:56](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L56) +Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:56](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L41) +Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:41](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L41) A Solid component that allows you to subscribe to the debouncer state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncDebouncerOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncDebouncerOptions.md index 686dd5aad..e63427912 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncDebouncerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncDebouncerOptions.md @@ -5,7 +5,7 @@ title: SolidAsyncDebouncerOptions # Interface: SolidAsyncDebouncerOptions\ -Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L13) +Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:13](https:/ optional onUnmount: (debouncer) => void; ``` -Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L21) +Defined in: [solid-pacer/src/async-debouncer/createAsyncDebouncer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-debouncer/createAsyncDebouncer.ts#L21) Optional callback invoked when the owning component unmounts. Receives the debouncer instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md b/docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md index dc4cb0501..43fae1784 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncQueuer.md @@ -5,7 +5,7 @@ title: SolidAsyncQueuer # Interface: SolidAsyncQueuer\ -Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:23](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L23) +Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:23](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L23) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:23](https://githu readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:49](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L49) +Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:49](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L49) Reactive state that will be updated when the queuer state changes @@ -44,7 +44,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:55](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L55) +Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:55](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L55) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:40](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L40) +Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:40](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L40) A Solid component that allows you to subscribe to the queuer state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncQueuerOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncQueuerOptions.md index eb5dcd234..1cfec1097 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncQueuerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncQueuerOptions.md @@ -5,7 +5,7 @@ title: SolidAsyncQueuerOptions # Interface: SolidAsyncQueuerOptions\ -Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:12](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L12) +Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:12](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L12) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:12](https://githu optional onUnmount: (queuer) => void; ``` -Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L20) +Defined in: [solid-pacer/src/async-queuer/createAsyncQueuer.ts:20](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-queuer/createAsyncQueuer.ts#L20) Optional callback invoked when the owning component unmounts. Receives the queuer instance. When provided, replaces the default cleanup (stop + abort); use it to call flush(), flushAsBatch(), stop(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiter.md b/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiter.md index a408f70bb..f6ba7e68e 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiter.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiter.md @@ -5,7 +5,7 @@ title: SolidAsyncRateLimiter # Interface: SolidAsyncRateLimiter\ -Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:24](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L24) +Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:24](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:24](ht readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:50](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L50) +Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:50](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L50) Reactive state that will be updated when the rate limiter state changes @@ -44,7 +44,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:56](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L56) +Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:56](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:41](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L41) +Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:41](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L41) A Solid component that allows you to subscribe to the rate limiter state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiterOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiterOptions.md index e2f51e4fe..234024e89 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiterOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncRateLimiterOptions.md @@ -5,7 +5,7 @@ title: SolidAsyncRateLimiterOptions # Interface: SolidAsyncRateLimiterOptions\ -Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L13) +Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:13](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:13](ht optional onUnmount: (rateLimiter) => void; ``` -Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L21) +Defined in: [solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts:21](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-rate-limiter/createAsyncRateLimiter.ts#L21) Optional callback invoked when the owning component unmounts. Receives the rate limiter instance. When provided, replaces the default cleanup (abort); use it to call reset(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncThrottler.md b/docs/framework/solid/reference/interfaces/SolidAsyncThrottler.md index 19df97311..3aa4280f6 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncThrottler.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncThrottler.md @@ -5,7 +5,7 @@ title: SolidAsyncThrottler # Interface: SolidAsyncThrottler\ -Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L24) +Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:24](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:24](https:/ readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:50](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L50) +Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:50](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L50) Reactive state that will be updated when the throttler state changes @@ -44,7 +44,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:56](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L56) +Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:56](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:41](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L41) +Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:41](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L41) A Solid component that allows you to subscribe to the throttler state. diff --git a/docs/framework/solid/reference/interfaces/SolidAsyncThrottlerOptions.md b/docs/framework/solid/reference/interfaces/SolidAsyncThrottlerOptions.md index 18cf685ea..707967b40 100644 --- a/docs/framework/solid/reference/interfaces/SolidAsyncThrottlerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidAsyncThrottlerOptions.md @@ -5,7 +5,7 @@ title: SolidAsyncThrottlerOptions # Interface: SolidAsyncThrottlerOptions\ -Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L13) +Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:13](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:13](https:/ optional onUnmount: (throttler) => void; ``` -Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L21) +Defined in: [solid-pacer/src/async-throttler/createAsyncThrottler.ts:21](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/async-throttler/createAsyncThrottler.ts#L21) Optional callback invoked when the owning component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel + abort); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidBatcher.md b/docs/framework/solid/reference/interfaces/SolidBatcher.md index fdfb171cf..d23d89eb0 100644 --- a/docs/framework/solid/reference/interfaces/SolidBatcher.md +++ b/docs/framework/solid/reference/interfaces/SolidBatcher.md @@ -5,7 +5,7 @@ title: SolidBatcher # Interface: SolidBatcher\ -Defined in: [solid-pacer/src/batcher/createBatcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L20) +Defined in: [solid-pacer/src/batcher/createBatcher.ts:20](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L20) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/batcher/createBatcher.ts:20](https://github.com/Tan readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/batcher/createBatcher.ts:46](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L46) +Defined in: [solid-pacer/src/batcher/createBatcher.ts:46](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L46) Reactive state that will be updated when the batcher state changes @@ -44,7 +44,7 @@ Use this instead of `batcher.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/batcher/createBatcher.ts:52](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L52) +Defined in: [solid-pacer/src/batcher/createBatcher.ts:52](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L52) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/batcher/createBatcher.ts:37](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L37) +Defined in: [solid-pacer/src/batcher/createBatcher.ts:37](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L37) A Solid component that allows you to subscribe to the batcher state. diff --git a/docs/framework/solid/reference/interfaces/SolidBatcherOptions.md b/docs/framework/solid/reference/interfaces/SolidBatcherOptions.md index 168f40b17..41b54c611 100644 --- a/docs/framework/solid/reference/interfaces/SolidBatcherOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidBatcherOptions.md @@ -5,7 +5,7 @@ title: SolidBatcherOptions # Interface: SolidBatcherOptions\ -Defined in: [solid-pacer/src/batcher/createBatcher.ts:9](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L9) +Defined in: [solid-pacer/src/batcher/createBatcher.ts:9](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L9) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/batcher/createBatcher.ts:9](https://github.com/TanS optional onUnmount: (batcher) => void; ``` -Defined in: [solid-pacer/src/batcher/createBatcher.ts:17](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L17) +Defined in: [solid-pacer/src/batcher/createBatcher.ts:17](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/batcher/createBatcher.ts#L17) Optional callback invoked when the owning component unmounts. Receives the batcher instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidDebouncer.md b/docs/framework/solid/reference/interfaces/SolidDebouncer.md index abb2e80a7..2e53a59d2 100644 --- a/docs/framework/solid/reference/interfaces/SolidDebouncer.md +++ b/docs/framework/solid/reference/interfaces/SolidDebouncer.md @@ -5,7 +5,7 @@ title: SolidDebouncer # Interface: SolidDebouncer\ -Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L24) +Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:24](https://github.com readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:50](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L50) +Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:50](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L50) Reactive state that will be updated when the debouncer state changes @@ -44,7 +44,7 @@ Use this instead of `debouncer.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:56](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L56) +Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:56](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L41) +Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:41](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L41) A Solid component that allows you to subscribe to the debouncer state. diff --git a/docs/framework/solid/reference/interfaces/SolidDebouncerOptions.md b/docs/framework/solid/reference/interfaces/SolidDebouncerOptions.md index d8898ab7c..e191086bf 100644 --- a/docs/framework/solid/reference/interfaces/SolidDebouncerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidDebouncerOptions.md @@ -5,7 +5,7 @@ title: SolidDebouncerOptions # Interface: SolidDebouncerOptions\ -Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L13) +Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:13](https://github.com optional onUnmount: (debouncer) => void; ``` -Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L21) +Defined in: [solid-pacer/src/debouncer/createDebouncer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/debouncer/createDebouncer.ts#L21) Optional callback invoked when the owning component unmounts. Receives the debouncer instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidQueuer.md b/docs/framework/solid/reference/interfaces/SolidQueuer.md index 7ab395cae..f9bef0999 100644 --- a/docs/framework/solid/reference/interfaces/SolidQueuer.md +++ b/docs/framework/solid/reference/interfaces/SolidQueuer.md @@ -5,7 +5,7 @@ title: SolidQueuer # Interface: SolidQueuer\ -Defined in: [solid-pacer/src/queuer/createQueuer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L20) +Defined in: [solid-pacer/src/queuer/createQueuer.ts:20](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L20) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/queuer/createQueuer.ts:20](https://github.com/TanSt readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/queuer/createQueuer.ts:46](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L46) +Defined in: [solid-pacer/src/queuer/createQueuer.ts:46](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L46) Reactive state that will be updated when the queuer state changes @@ -44,7 +44,7 @@ Use this instead of `queuer.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/queuer/createQueuer.ts:52](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L52) +Defined in: [solid-pacer/src/queuer/createQueuer.ts:52](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L52) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/queuer/createQueuer.ts:37](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L37) +Defined in: [solid-pacer/src/queuer/createQueuer.ts:37](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L37) A Solid component that allows you to subscribe to the queuer state. diff --git a/docs/framework/solid/reference/interfaces/SolidQueuerOptions.md b/docs/framework/solid/reference/interfaces/SolidQueuerOptions.md index 7ea2c889a..53417300e 100644 --- a/docs/framework/solid/reference/interfaces/SolidQueuerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidQueuerOptions.md @@ -5,7 +5,7 @@ title: SolidQueuerOptions # Interface: SolidQueuerOptions\ -Defined in: [solid-pacer/src/queuer/createQueuer.ts:9](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L9) +Defined in: [solid-pacer/src/queuer/createQueuer.ts:9](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L9) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/queuer/createQueuer.ts:9](https://github.com/TanSta optional onUnmount: (queuer) => void; ``` -Defined in: [solid-pacer/src/queuer/createQueuer.ts:17](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L17) +Defined in: [solid-pacer/src/queuer/createQueuer.ts:17](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/queuer/createQueuer.ts#L17) Optional callback invoked when the owning component unmounts. Receives the queuer instance. When provided, replaces the default cleanup (stop); use it to call flush(), flushAsBatch(), stop(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidRateLimiter.md b/docs/framework/solid/reference/interfaces/SolidRateLimiter.md index f26f5c2b9..9b0186fa4 100644 --- a/docs/framework/solid/reference/interfaces/SolidRateLimiter.md +++ b/docs/framework/solid/reference/interfaces/SolidRateLimiter.md @@ -5,7 +5,7 @@ title: SolidRateLimiter # Interface: SolidRateLimiter\ -Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:24](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L24) +Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:24](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:24](https://githu readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:50](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L50) +Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:50](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L50) Reactive state that will be updated when the rate limiter state changes @@ -44,7 +44,7 @@ Use this instead of `rateLimiter.store.state` readonly store: Store>; ``` -Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:56](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L56) +Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:56](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:41](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L41) +Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:41](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L41) A Solid component that allows you to subscribe to the rate limiter state. diff --git a/docs/framework/solid/reference/interfaces/SolidRateLimiterOptions.md b/docs/framework/solid/reference/interfaces/SolidRateLimiterOptions.md index 4a83d0cf9..d73947860 100644 --- a/docs/framework/solid/reference/interfaces/SolidRateLimiterOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidRateLimiterOptions.md @@ -5,7 +5,7 @@ title: SolidRateLimiterOptions # Interface: SolidRateLimiterOptions\ -Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:13](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L13) +Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:13](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:13](https://githu optional onUnmount: (rateLimiter) => void; ``` -Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L21) +Defined in: [solid-pacer/src/rate-limiter/createRateLimiter.ts:21](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/rate-limiter/createRateLimiter.ts#L21) Optional callback invoked when the owning component unmounts. Receives the rate limiter instance. When provided, replaces the default cleanup; use it to call reset(), add logging, etc. diff --git a/docs/framework/solid/reference/interfaces/SolidThrottler.md b/docs/framework/solid/reference/interfaces/SolidThrottler.md index 7c10ea39d..e593c888f 100644 --- a/docs/framework/solid/reference/interfaces/SolidThrottler.md +++ b/docs/framework/solid/reference/interfaces/SolidThrottler.md @@ -5,7 +5,7 @@ title: SolidThrottler # Interface: SolidThrottler\ -Defined in: [solid-pacer/src/throttler/createThrottler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L24) +Defined in: [solid-pacer/src/throttler/createThrottler.ts:24](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L24) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/throttler/createThrottler.ts:24](https://github.com readonly state: Accessor>; ``` -Defined in: [solid-pacer/src/throttler/createThrottler.ts:50](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L50) +Defined in: [solid-pacer/src/throttler/createThrottler.ts:50](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L50) Reactive state that will be updated when the throttler state changes @@ -44,7 +44,7 @@ Use this instead of `throttler.store.state` readonly store: Store>>; ``` -Defined in: [solid-pacer/src/throttler/createThrottler.ts:56](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L56) +Defined in: [solid-pacer/src/throttler/createThrottler.ts:56](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L56) #### Deprecated @@ -60,7 +60,7 @@ Although, you can make the state reactive by using the `useStore` in your own us Subscribe: (props) => Element; ``` -Defined in: [solid-pacer/src/throttler/createThrottler.ts:41](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L41) +Defined in: [solid-pacer/src/throttler/createThrottler.ts:41](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L41) A Solid component that allows you to subscribe to the throttler state. diff --git a/docs/framework/solid/reference/interfaces/SolidThrottlerOptions.md b/docs/framework/solid/reference/interfaces/SolidThrottlerOptions.md index c099b26be..630665d54 100644 --- a/docs/framework/solid/reference/interfaces/SolidThrottlerOptions.md +++ b/docs/framework/solid/reference/interfaces/SolidThrottlerOptions.md @@ -5,7 +5,7 @@ title: SolidThrottlerOptions # Interface: SolidThrottlerOptions\ -Defined in: [solid-pacer/src/throttler/createThrottler.ts:13](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L13) +Defined in: [solid-pacer/src/throttler/createThrottler.ts:13](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L13) ## Extends @@ -30,7 +30,7 @@ Defined in: [solid-pacer/src/throttler/createThrottler.ts:13](https://github.com optional onUnmount: (throttler) => void; ``` -Defined in: [solid-pacer/src/throttler/createThrottler.ts:21](https://github.com/TanStack/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L21) +Defined in: [solid-pacer/src/throttler/createThrottler.ts:21](https://github.com/ghostd/pacer/blob/main/packages/solid-pacer/src/throttler/createThrottler.ts#L21) Optional callback invoked when the owning component unmounts. Receives the throttler instance. When provided, replaces the default cleanup (cancel); use it to call flush(), reset(), cancel(), add logging, etc. diff --git a/docs/reference/classes/AsyncBatcher.md b/docs/reference/classes/AsyncBatcher.md index 7124b76a8..d3eea44c6 100644 --- a/docs/reference/classes/AsyncBatcher.md +++ b/docs/reference/classes/AsyncBatcher.md @@ -5,7 +5,7 @@ title: AsyncBatcher # Class: AsyncBatcher\ -Defined in: [async-batcher.ts:265](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L265) +Defined in: [async-batcher.ts:265](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L265) A class that collects items and processes them in batches asynchronously. @@ -88,7 +88,7 @@ batcher.addItem(2); new AsyncBatcher(fn, initialOptions): AsyncBatcher; ``` -Defined in: [async-batcher.ts:277](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L277) +Defined in: [async-batcher.ts:277](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L277) #### Parameters @@ -112,7 +112,7 @@ Defined in: [async-batcher.ts:277](https://github.com/TanStack/pacer/blob/main/p asyncRetryers: Map Promise>>; ``` -Defined in: [async-batcher.ts:271](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L271) +Defined in: [async-batcher.ts:271](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L271) *** @@ -122,7 +122,7 @@ Defined in: [async-batcher.ts:271](https://github.com/TanStack/pacer/blob/main/p fn: (items) => Promise; ``` -Defined in: [async-batcher.ts:278](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L278) +Defined in: [async-batcher.ts:278](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L278) #### Parameters @@ -142,7 +142,7 @@ Defined in: [async-batcher.ts:278](https://github.com/TanStack/pacer/blob/main/p key: string | undefined; ``` -Defined in: [async-batcher.ts:269](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L269) +Defined in: [async-batcher.ts:269](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L269) *** @@ -152,7 +152,7 @@ Defined in: [async-batcher.ts:269](https://github.com/TanStack/pacer/blob/main/p options: AsyncBatcherOptionsWithOptionalCallbacks; ``` -Defined in: [async-batcher.ts:270](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L270) +Defined in: [async-batcher.ts:270](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L270) *** @@ -162,7 +162,7 @@ Defined in: [async-batcher.ts:270](https://github.com/TanStack/pacer/blob/main/p readonly store: Store>>; ``` -Defined in: [async-batcher.ts:266](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L266) +Defined in: [async-batcher.ts:266](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L266) ## Methods @@ -172,7 +172,7 @@ Defined in: [async-batcher.ts:266](https://github.com/TanStack/pacer/blob/main/p abort(): void; ``` -Defined in: [async-batcher.ts:490](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L490) +Defined in: [async-batcher.ts:490](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L490) Aborts all ongoing executions with the internal abort controllers. Does NOT cancel any pending execution that have not started yet. @@ -190,7 +190,7 @@ Does NOT clear out the items. addItem(item): Promise; ``` -Defined in: [async-batcher.ts:342](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L342) +Defined in: [async-batcher.ts:342](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L342) Adds an item to the async batcher If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed @@ -219,7 +219,7 @@ The error from the batch function if no onError handler is configured or throwOn cancel(): void; ``` -Defined in: [async-batcher.ts:503](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L503) +Defined in: [async-batcher.ts:503](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L503) Cancels any pending execution that have not started yet. Does NOT abort any execution already in progress. @@ -237,7 +237,7 @@ Does NOT clear out the items. clear(): void; ``` -Defined in: [async-batcher.ts:451](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L451) +Defined in: [async-batcher.ts:451](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L451) Removes all items from the async batcher @@ -253,7 +253,7 @@ Removes all items from the async batcher flush(): Promise; ``` -Defined in: [async-batcher.ts:425](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L425) +Defined in: [async-batcher.ts:425](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L425) Processes the current batch of items immediately @@ -269,7 +269,7 @@ Processes the current batch of items immediately getAbortSignal(executeCount?): AbortSignal | null; ``` -Defined in: [async-batcher.ts:479](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L479) +Defined in: [async-batcher.ts:479](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L479) Returns the AbortSignal for a specific execution. If no executeCount is provided, returns the signal for the most recent execution. @@ -314,7 +314,7 @@ const batcher = new AsyncBatcher( peekAllItems(): TValue[]; ``` -Defined in: [async-batcher.ts:433](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L433) +Defined in: [async-batcher.ts:433](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L433) Returns a copy of all items in the async batcher @@ -330,7 +330,7 @@ Returns a copy of all items in the async batcher peekFailedItems(): TValue[]; ``` -Defined in: [async-batcher.ts:437](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L437) +Defined in: [async-batcher.ts:437](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L437) #### Returns @@ -344,7 +344,7 @@ Defined in: [async-batcher.ts:437](https://github.com/TanStack/pacer/blob/main/p reset(): void; ``` -Defined in: [async-batcher.ts:513](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L513) +Defined in: [async-batcher.ts:513](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L513) Resets the async batcher state to its default values @@ -360,7 +360,7 @@ Resets the async batcher state to its default values setOptions(newOptions): void; ``` -Defined in: [async-batcher.ts:301](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L301) +Defined in: [async-batcher.ts:301](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L301) Updates the async batcher options diff --git a/docs/reference/classes/AsyncDebouncer.md b/docs/reference/classes/AsyncDebouncer.md index f98866a36..af8f1b930 100644 --- a/docs/reference/classes/AsyncDebouncer.md +++ b/docs/reference/classes/AsyncDebouncer.md @@ -5,7 +5,7 @@ title: AsyncDebouncer # Class: AsyncDebouncer\ -Defined in: [async-debouncer.ts:218](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L218) +Defined in: [async-debouncer.ts:218](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L218) A class that creates an async debounced function. @@ -75,7 +75,7 @@ const results = await asyncDebouncer.maybeExecute(inputElement.value); new AsyncDebouncer(fn, initialOptions): AsyncDebouncer; ``` -Defined in: [async-debouncer.ts:230](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L230) +Defined in: [async-debouncer.ts:230](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L230) #### Parameters @@ -99,7 +99,7 @@ Defined in: [async-debouncer.ts:230](https://github.com/TanStack/pacer/blob/main asyncRetryers: Map>; ``` -Defined in: [async-debouncer.ts:224](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L224) +Defined in: [async-debouncer.ts:224](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L224) *** @@ -109,7 +109,7 @@ Defined in: [async-debouncer.ts:224](https://github.com/TanStack/pacer/blob/main fn: TFn; ``` -Defined in: [async-debouncer.ts:231](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L231) +Defined in: [async-debouncer.ts:231](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L231) *** @@ -119,7 +119,7 @@ Defined in: [async-debouncer.ts:231](https://github.com/TanStack/pacer/blob/main key: string | undefined; ``` -Defined in: [async-debouncer.ts:222](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L222) +Defined in: [async-debouncer.ts:222](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L222) *** @@ -129,7 +129,7 @@ Defined in: [async-debouncer.ts:222](https://github.com/TanStack/pacer/blob/main options: AsyncDebouncerOptions; ``` -Defined in: [async-debouncer.ts:223](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L223) +Defined in: [async-debouncer.ts:223](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L223) *** @@ -139,7 +139,7 @@ Defined in: [async-debouncer.ts:223](https://github.com/TanStack/pacer/blob/main readonly store: Store>>; ``` -Defined in: [async-debouncer.ts:219](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L219) +Defined in: [async-debouncer.ts:219](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L219) ## Methods @@ -149,7 +149,7 @@ Defined in: [async-debouncer.ts:219](https://github.com/TanStack/pacer/blob/main abort(): void; ``` -Defined in: [async-debouncer.ts:465](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L465) +Defined in: [async-debouncer.ts:465](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L465) Aborts all ongoing executions with the internal abort controllers. Does NOT cancel any pending execution that have not started yet. @@ -166,7 +166,7 @@ Does NOT cancel any pending execution that have not started yet. cancel(): void; ``` -Defined in: [async-debouncer.ts:477](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L477) +Defined in: [async-debouncer.ts:477](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L477) Cancels any pending execution that have not started yet. Does NOT abort any execution already in progress. @@ -180,16 +180,16 @@ Does NOT abort any execution already in progress. ### flush() ```ts -flush(): Promise | undefined>; +flush(): Promise> | undefined>; ``` -Defined in: [async-debouncer.ts:400](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L400) +Defined in: [async-debouncer.ts:400](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L400) Processes the current pending execution immediately #### Returns -`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\> *** @@ -199,7 +199,7 @@ Processes the current pending execution immediately getAbortSignal(maybeExecuteCount?): AbortSignal | null; ``` -Defined in: [async-debouncer.ts:455](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L455) +Defined in: [async-debouncer.ts:455](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L455) Returns the AbortSignal for a specific execution. If no maybeExecuteCount is provided, returns the signal for the most recent execution. @@ -237,10 +237,10 @@ const debouncer = new AsyncDebouncer( ### maybeExecute() ```ts -maybeExecute(...args): Promise | undefined>; +maybeExecute(...args): Promise> | undefined>; ``` -Defined in: [async-debouncer.ts:314](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L314) +Defined in: [async-debouncer.ts:314](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L314) Attempts to execute the debounced function. If a call is already in progress, it will be queued. @@ -260,7 +260,7 @@ Error Handling: #### Returns -`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\> A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError @@ -276,7 +276,7 @@ The error from the debounced function if no onError handler is configured reset(): void; ``` -Defined in: [async-debouncer.ts:485](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L485) +Defined in: [async-debouncer.ts:485](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L485) Resets the debouncer state to its default values @@ -292,7 +292,7 @@ Resets the debouncer state to its default values setOptions(newOptions): void; ``` -Defined in: [async-debouncer.ts:254](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L254) +Defined in: [async-debouncer.ts:254](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L254) Updates the async debouncer options diff --git a/docs/reference/classes/AsyncQueuer.md b/docs/reference/classes/AsyncQueuer.md index 523bbe7d9..a318b6ba5 100644 --- a/docs/reference/classes/AsyncQueuer.md +++ b/docs/reference/classes/AsyncQueuer.md @@ -5,7 +5,7 @@ title: AsyncQueuer # Class: AsyncQueuer\ -Defined in: [async-queuer.ts:315](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L315) +Defined in: [async-queuer.ts:315](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L315) A flexible asynchronous queue for processing tasks with configurable concurrency, priority, and expiration. @@ -84,7 +84,7 @@ asyncQueuer.start(); new AsyncQueuer(fn, initialOptions): AsyncQueuer; ``` -Defined in: [async-queuer.ts:327](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L327) +Defined in: [async-queuer.ts:327](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L327) #### Parameters @@ -108,7 +108,7 @@ Defined in: [async-queuer.ts:327](https://github.com/TanStack/pacer/blob/main/pa asyncRetryers: Map Promise>>; ``` -Defined in: [async-queuer.ts:321](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L321) +Defined in: [async-queuer.ts:321](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L321) *** @@ -118,7 +118,7 @@ Defined in: [async-queuer.ts:321](https://github.com/TanStack/pacer/blob/main/pa fn: (item) => Promise; ``` -Defined in: [async-queuer.ts:328](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L328) +Defined in: [async-queuer.ts:328](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L328) #### Parameters @@ -138,7 +138,7 @@ Defined in: [async-queuer.ts:328](https://github.com/TanStack/pacer/blob/main/pa key: string | undefined; ``` -Defined in: [async-queuer.ts:319](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L319) +Defined in: [async-queuer.ts:319](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L319) *** @@ -148,7 +148,7 @@ Defined in: [async-queuer.ts:319](https://github.com/TanStack/pacer/blob/main/pa options: AsyncQueuerOptions; ``` -Defined in: [async-queuer.ts:320](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L320) +Defined in: [async-queuer.ts:320](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L320) *** @@ -158,7 +158,7 @@ Defined in: [async-queuer.ts:320](https://github.com/TanStack/pacer/blob/main/pa readonly store: Store>>; ``` -Defined in: [async-queuer.ts:316](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L316) +Defined in: [async-queuer.ts:316](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L316) ## Methods @@ -168,7 +168,7 @@ Defined in: [async-queuer.ts:316](https://github.com/TanStack/pacer/blob/main/pa abort(): void; ``` -Defined in: [async-queuer.ts:832](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L832) +Defined in: [async-queuer.ts:832](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L832) Aborts all ongoing executions with the internal abort controllers. Does NOT clear out the items. @@ -188,7 +188,7 @@ addItem( runOnItemsChange): boolean; ``` -Defined in: [async-queuer.ts:470](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L470) +Defined in: [async-queuer.ts:470](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L470) Adds an item to the queue. If the queue is full, the item is rejected and onReject is called. Items can be inserted based on priority or at the front/back depending on configuration. @@ -226,7 +226,7 @@ queuer.addItem('task2', 'front'); clear(): void; ``` -Defined in: [async-queuer.ts:797](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L797) +Defined in: [async-queuer.ts:797](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L797) Removes all pending items from the queue. Does NOT affect active tasks. @@ -243,7 +243,7 @@ Does NOT affect active tasks. execute(position?): Promise; ``` -Defined in: [async-queuer.ts:605](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L605) +Defined in: [async-queuer.ts:605](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L605) Removes and returns the next item from the queue and executes the task function with it. @@ -273,7 +273,7 @@ queuer.execute('back'); flush(numberOfItems, position?): Promise; ``` -Defined in: [async-queuer.ts:653](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L653) +Defined in: [async-queuer.ts:653](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L653) Processes a specified number of items to execute immediately with no wait time If no numberOfItems is provided, all items will be processed @@ -300,7 +300,7 @@ If no numberOfItems is provided, all items will be processed flushAsBatch(batchFunction): Promise; ``` -Defined in: [async-queuer.ts:667](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L667) +Defined in: [async-queuer.ts:667](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L667) Processes all items in the queue as a batch using the provided function as an argument The queue is cleared after processing @@ -323,7 +323,7 @@ The queue is cleared after processing getAbortSignal(executeCount?): AbortSignal | null; ``` -Defined in: [async-queuer.ts:822](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L822) +Defined in: [async-queuer.ts:822](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L822) Returns the AbortSignal for a specific execution. If no executeCount is provided, returns the signal for the most recent execution. @@ -364,7 +364,7 @@ const queuer = new AsyncQueuer( getNextItem(position): TValue | undefined; ``` -Defined in: [async-queuer.ts:553](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L553) +Defined in: [async-queuer.ts:553](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L553) Removes and returns the next item from the queue without executing the task function. Use for manual queue management. Normally, use execute() to process items. @@ -396,7 +396,7 @@ queuer.getNextItem('back'); peekActiveItems(): TValue[]; ``` -Defined in: [async-queuer.ts:759](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L759) +Defined in: [async-queuer.ts:759](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L759) Returns the items currently being processed (active tasks). @@ -412,7 +412,7 @@ Returns the items currently being processed (active tasks). peekAllItems(): TValue[]; ``` -Defined in: [async-queuer.ts:752](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L752) +Defined in: [async-queuer.ts:752](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L752) Returns a copy of all items in the queue, including active and pending items. @@ -428,7 +428,7 @@ Returns a copy of all items in the queue, including active and pending items. peekNextItem(position): TValue | undefined; ``` -Defined in: [async-queuer.ts:742](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L742) +Defined in: [async-queuer.ts:742](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L742) Returns the next item in the queue without removing it. @@ -457,7 +457,7 @@ queuer.peekNextItem('back'); // back peekPendingItems(): TValue[]; ``` -Defined in: [async-queuer.ts:766](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L766) +Defined in: [async-queuer.ts:766](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L766) Returns the items waiting to be processed (pending tasks). @@ -473,7 +473,7 @@ Returns the items waiting to be processed (pending tasks). reset(): void; ``` -Defined in: [async-queuer.ts:843](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L843) +Defined in: [async-queuer.ts:843](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L843) Resets the queuer state to its default values @@ -489,7 +489,7 @@ Resets the queuer state to its default values setOptions(newOptions): void; ``` -Defined in: [async-queuer.ts:368](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L368) +Defined in: [async-queuer.ts:368](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L368) Updates the queuer options. New options are merged with existing options. @@ -511,7 +511,7 @@ Updates the queuer options. New options are merged with existing options. start(): void; ``` -Defined in: [async-queuer.ts:773](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L773) +Defined in: [async-queuer.ts:773](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L773) Starts processing items in the queue. If already running, does nothing. @@ -527,7 +527,7 @@ Starts processing items in the queue. If already running, does nothing. stop(): void; ``` -Defined in: [async-queuer.ts:783](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L783) +Defined in: [async-queuer.ts:783](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L783) Stops processing items in the queue. Does not clear the queue. diff --git a/docs/reference/classes/AsyncRateLimiter.md b/docs/reference/classes/AsyncRateLimiter.md index 76bb28e5e..d3748632c 100644 --- a/docs/reference/classes/AsyncRateLimiter.md +++ b/docs/reference/classes/AsyncRateLimiter.md @@ -5,7 +5,7 @@ title: AsyncRateLimiter # Class: AsyncRateLimiter\ -Defined in: [async-rate-limiter.ts:245](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L245) +Defined in: [async-rate-limiter.ts:245](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L245) A class that creates an async rate-limited function. @@ -95,7 +95,7 @@ const data = await rateLimiter.maybeExecute('123'); new AsyncRateLimiter(fn, initialOptions): AsyncRateLimiter; ``` -Defined in: [async-rate-limiter.ts:254](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L254) +Defined in: [async-rate-limiter.ts:254](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L254) #### Parameters @@ -119,7 +119,7 @@ Defined in: [async-rate-limiter.ts:254](https://github.com/TanStack/pacer/blob/m asyncRetryers: Map>; ``` -Defined in: [async-rate-limiter.ts:251](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L251) +Defined in: [async-rate-limiter.ts:251](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L251) *** @@ -129,7 +129,7 @@ Defined in: [async-rate-limiter.ts:251](https://github.com/TanStack/pacer/blob/m fn: TFn; ``` -Defined in: [async-rate-limiter.ts:255](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L255) +Defined in: [async-rate-limiter.ts:255](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L255) *** @@ -139,7 +139,7 @@ Defined in: [async-rate-limiter.ts:255](https://github.com/TanStack/pacer/blob/m key: string | undefined; ``` -Defined in: [async-rate-limiter.ts:249](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L249) +Defined in: [async-rate-limiter.ts:249](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L249) *** @@ -149,7 +149,7 @@ Defined in: [async-rate-limiter.ts:249](https://github.com/TanStack/pacer/blob/m options: AsyncRateLimiterOptions; ``` -Defined in: [async-rate-limiter.ts:250](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L250) +Defined in: [async-rate-limiter.ts:250](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L250) *** @@ -159,7 +159,7 @@ Defined in: [async-rate-limiter.ts:250](https://github.com/TanStack/pacer/blob/m readonly store: Store>>; ``` -Defined in: [async-rate-limiter.ts:246](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L246) +Defined in: [async-rate-limiter.ts:246](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L246) ## Methods @@ -169,7 +169,7 @@ Defined in: [async-rate-limiter.ts:246](https://github.com/TanStack/pacer/blob/m abort(): void; ``` -Defined in: [async-rate-limiter.ts:535](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L535) +Defined in: [async-rate-limiter.ts:535](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L535) Aborts all ongoing executions with the internal abort controllers. Does NOT clear out the execution times or reset the rate limiter. @@ -186,7 +186,7 @@ Does NOT clear out the execution times or reset the rate limiter. getAbortSignal(maybeExecuteCount?): AbortSignal | null; ``` -Defined in: [async-rate-limiter.ts:525](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L525) +Defined in: [async-rate-limiter.ts:525](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L525) Returns the AbortSignal for a specific execution. If no maybeExecuteCount is provided, returns the signal for the most recent execution. @@ -227,7 +227,7 @@ const rateLimiter = new AsyncRateLimiter( getMsUntilNextWindow(): number; ``` -Defined in: [async-rate-limiter.ts:497](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L497) +Defined in: [async-rate-limiter.ts:497](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L497) Returns the number of milliseconds until the next execution will be possible For fixed windows, this is the time until the current window resets @@ -245,7 +245,7 @@ For sliding windows, this is the time until the oldest execution expires getRemainingInWindow(): number; ``` -Defined in: [async-rate-limiter.ts:487](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L487) +Defined in: [async-rate-limiter.ts:487](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L487) Returns the number of remaining executions allowed in the current window @@ -258,10 +258,10 @@ Returns the number of remaining executions allowed in the current window ### maybeExecute() ```ts -maybeExecute(...args): Promise | undefined>; +maybeExecute(...args): Promise> | undefined>; ``` -Defined in: [async-rate-limiter.ts:354](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L354) +Defined in: [async-rate-limiter.ts:354](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L354) Attempts to execute the rate-limited function if within the configured limits. Will reject execution if the number of calls in the current window exceeds the limit. @@ -281,7 +281,7 @@ Error Handling: #### Returns -`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\> A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError @@ -309,7 +309,7 @@ const result2 = await rateLimiter.maybeExecute('arg1', 'arg2'); // undefined reset(): void; ``` -Defined in: [async-rate-limiter.ts:546](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L546) +Defined in: [async-rate-limiter.ts:546](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L546) Resets the rate limiter state @@ -325,7 +325,7 @@ Resets the rate limiter state setOptions(newOptions): void; ``` -Defined in: [async-rate-limiter.ts:281](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L281) +Defined in: [async-rate-limiter.ts:281](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L281) Updates the async rate limiter options diff --git a/docs/reference/classes/AsyncRetryer.md b/docs/reference/classes/AsyncRetryer.md index af034467c..3b58046f4 100644 --- a/docs/reference/classes/AsyncRetryer.md +++ b/docs/reference/classes/AsyncRetryer.md @@ -5,7 +5,7 @@ title: AsyncRetryer # Class: AsyncRetryer\ -Defined in: [async-retryer.ts:296](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L296) +Defined in: [async-retryer.ts:296](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L296) Provides robust retry functionality for asynchronous functions, supporting configurable backoff strategies, attempt limits, timeout controls, and detailed state management. The AsyncRetryer class is designed to help you reliably @@ -115,7 +115,7 @@ The async function type to be retried. new AsyncRetryer(fn, initialOptions): AsyncRetryer; ``` -Defined in: [async-retryer.ts:309](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L309) +Defined in: [async-retryer.ts:309](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L309) Creates a new AsyncRetryer instance @@ -145,7 +145,7 @@ Configuration options for the retryer fn: TFn; ``` -Defined in: [async-retryer.ts:310](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L310) +Defined in: [async-retryer.ts:310](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L310) The async function to retry @@ -157,7 +157,7 @@ The async function to retry key: string | undefined; ``` -Defined in: [async-retryer.ts:300](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L300) +Defined in: [async-retryer.ts:300](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L300) *** @@ -177,7 +177,7 @@ options: AsyncRetryerOptions & Omit>, | "onTotalExecutionTimeout">; ``` -Defined in: [async-retryer.ts:301](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L301) +Defined in: [async-retryer.ts:301](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L301) *** @@ -187,7 +187,7 @@ Defined in: [async-retryer.ts:301](https://github.com/TanStack/pacer/blob/main/p readonly store: Store>>; ``` -Defined in: [async-retryer.ts:297](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L297) +Defined in: [async-retryer.ts:297](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L297) ## Methods @@ -197,7 +197,7 @@ Defined in: [async-retryer.ts:297](https://github.com/TanStack/pacer/blob/main/p abort(reason): void; ``` -Defined in: [async-retryer.ts:619](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L619) +Defined in: [async-retryer.ts:619](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L619) Cancels the current execution and any pending retries @@ -221,7 +221,7 @@ The reason for the abort (defaults to 'manual') execute(...args): Promise> | undefined>; ``` -Defined in: [async-retryer.ts:426](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L426) +Defined in: [async-retryer.ts:426](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L426) Executes the function with retry logic @@ -251,7 +251,7 @@ The last error if throwOnError is true and all retries fail getAbortSignal(): AbortSignal | null; ``` -Defined in: [async-retryer.ts:611](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L611) +Defined in: [async-retryer.ts:611](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L611) Returns the current AbortSignal for the executing operation. Use this signal in your async function to make it cancellable. @@ -284,7 +284,7 @@ retryer.abort() reset(): void; ``` -Defined in: [async-retryer.ts:639](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L639) +Defined in: [async-retryer.ts:639](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L639) Resets the retryer to its initial state @@ -300,7 +300,7 @@ Resets the retryer to its initial state setOptions(newOptions): void; ``` -Defined in: [async-retryer.ts:336](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L336) +Defined in: [async-retryer.ts:336](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L336) Updates the retryer options diff --git a/docs/reference/classes/AsyncThrottler.md b/docs/reference/classes/AsyncThrottler.md index 3759d03e6..0daf10ecb 100644 --- a/docs/reference/classes/AsyncThrottler.md +++ b/docs/reference/classes/AsyncThrottler.md @@ -5,7 +5,7 @@ title: AsyncThrottler # Class: AsyncThrottler\ -Defined in: [async-throttler.ts:230](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L230) +Defined in: [async-throttler.ts:230](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L230) A class that creates an async throttled function. @@ -79,7 +79,7 @@ const result = await throttler.maybeExecute(inputElement.value); new AsyncThrottler(fn, initialOptions): AsyncThrottler; ``` -Defined in: [async-throttler.ts:242](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L242) +Defined in: [async-throttler.ts:242](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L242) #### Parameters @@ -103,7 +103,7 @@ Defined in: [async-throttler.ts:242](https://github.com/TanStack/pacer/blob/main asyncRetryers: Map>; ``` -Defined in: [async-throttler.ts:236](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L236) +Defined in: [async-throttler.ts:236](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L236) *** @@ -113,7 +113,7 @@ Defined in: [async-throttler.ts:236](https://github.com/TanStack/pacer/blob/main fn: TFn; ``` -Defined in: [async-throttler.ts:243](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L243) +Defined in: [async-throttler.ts:243](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L243) *** @@ -123,7 +123,7 @@ Defined in: [async-throttler.ts:243](https://github.com/TanStack/pacer/blob/main key: string | undefined; ``` -Defined in: [async-throttler.ts:234](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L234) +Defined in: [async-throttler.ts:234](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L234) *** @@ -133,7 +133,7 @@ Defined in: [async-throttler.ts:234](https://github.com/TanStack/pacer/blob/main options: AsyncThrottlerOptions; ``` -Defined in: [async-throttler.ts:235](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L235) +Defined in: [async-throttler.ts:235](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L235) *** @@ -143,7 +143,7 @@ Defined in: [async-throttler.ts:235](https://github.com/TanStack/pacer/blob/main readonly store: Store>>; ``` -Defined in: [async-throttler.ts:231](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L231) +Defined in: [async-throttler.ts:231](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L231) ## Methods @@ -153,7 +153,7 @@ Defined in: [async-throttler.ts:231](https://github.com/TanStack/pacer/blob/main abort(): void; ``` -Defined in: [async-throttler.ts:529](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L529) +Defined in: [async-throttler.ts:531](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L531) Aborts all ongoing executions with the internal abort controllers. Does NOT cancel any pending execution that have not started yet. @@ -170,7 +170,7 @@ Does NOT cancel any pending execution that have not started yet. cancel(): void; ``` -Defined in: [async-throttler.ts:539](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L539) +Defined in: [async-throttler.ts:541](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L541) Cancels any pending execution that have not started yet. Does NOT abort any execution already in progress. @@ -184,16 +184,16 @@ Does NOT abort any execution already in progress. ### flush() ```ts -flush(): Promise | undefined>; +flush(): Promise> | undefined>; ``` -Defined in: [async-throttler.ts:458](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L458) +Defined in: [async-throttler.ts:460](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L460) Processes the current pending execution immediately #### Returns -`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\> *** @@ -203,7 +203,7 @@ Processes the current pending execution immediately getAbortSignal(maybeExecuteCount?): AbortSignal | null; ``` -Defined in: [async-throttler.ts:519](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L519) +Defined in: [async-throttler.ts:521](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L521) Returns the AbortSignal for a specific execution. If no maybeExecuteCount is provided, returns the signal for the most recent execution. @@ -245,10 +245,10 @@ const throttler = new AsyncThrottler( ### maybeExecute() ```ts -maybeExecute(...args): Promise | undefined>; +maybeExecute(...args): Promise> | undefined>; ``` -Defined in: [async-throttler.ts:334](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L334) +Defined in: [async-throttler.ts:334](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L334) Attempts to execute the throttled function. The execution behavior depends on the throttler options: @@ -268,7 +268,7 @@ Attempts to execute the throttled function. The execution behavior depends on th #### Returns -`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\> #### Example @@ -290,7 +290,7 @@ await throttled.maybeExecute('c', 'd'); reset(): void; ``` -Defined in: [async-throttler.ts:553](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L553) +Defined in: [async-throttler.ts:555](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L555) Resets the debouncer state to its default values @@ -306,7 +306,7 @@ Resets the debouncer state to its default values setOptions(newOptions): void; ``` -Defined in: [async-throttler.ts:266](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L266) +Defined in: [async-throttler.ts:266](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L266) Updates the async throttler options diff --git a/docs/reference/classes/Batcher.md b/docs/reference/classes/Batcher.md index ceda95922..cfd5e8a8d 100644 --- a/docs/reference/classes/Batcher.md +++ b/docs/reference/classes/Batcher.md @@ -5,7 +5,7 @@ title: Batcher # Class: Batcher\ -Defined in: [batcher.ts:145](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L145) +Defined in: [batcher.ts:145](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L145) A class that collects items and processes them in batches. @@ -60,7 +60,7 @@ batcher.addItem(2); new Batcher(fn, initialOptions): Batcher; ``` -Defined in: [batcher.ts:153](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L153) +Defined in: [batcher.ts:153](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L153) #### Parameters @@ -84,7 +84,7 @@ Defined in: [batcher.ts:153](https://github.com/TanStack/pacer/blob/main/package fn: (items) => void; ``` -Defined in: [batcher.ts:154](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L154) +Defined in: [batcher.ts:154](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L154) #### Parameters @@ -104,7 +104,7 @@ Defined in: [batcher.ts:154](https://github.com/TanStack/pacer/blob/main/package key: string | undefined; ``` -Defined in: [batcher.ts:149](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L149) +Defined in: [batcher.ts:149](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L149) *** @@ -114,7 +114,7 @@ Defined in: [batcher.ts:149](https://github.com/TanStack/pacer/blob/main/package options: BatcherOptionsWithOptionalCallbacks; ``` -Defined in: [batcher.ts:150](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L150) +Defined in: [batcher.ts:150](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L150) *** @@ -124,7 +124,7 @@ Defined in: [batcher.ts:150](https://github.com/TanStack/pacer/blob/main/package readonly store: Store>>; ``` -Defined in: [batcher.ts:146](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L146) +Defined in: [batcher.ts:146](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L146) ## Methods @@ -134,7 +134,7 @@ Defined in: [batcher.ts:146](https://github.com/TanStack/pacer/blob/main/package addItem(item): void; ``` -Defined in: [batcher.ts:207](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L207) +Defined in: [batcher.ts:207](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L207) Adds an item to the batcher If the batch size is reached, timeout occurs, or shouldProcess returns true, the batch will be processed @@ -157,7 +157,7 @@ If the batch size is reached, timeout occurs, or shouldProcess returns true, the cancel(): void; ``` -Defined in: [batcher.ts:285](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L285) +Defined in: [batcher.ts:285](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L285) Cancels any pending execution that was scheduled. Does NOT clear out the items. @@ -174,7 +174,7 @@ Does NOT clear out the items. clear(): void; ``` -Defined in: [batcher.ts:277](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L277) +Defined in: [batcher.ts:277](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L277) Removes all items from the batcher @@ -190,7 +190,7 @@ Removes all items from the batcher flush(): void; ``` -Defined in: [batcher.ts:255](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L255) +Defined in: [batcher.ts:255](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L255) Processes the current batch of items immediately @@ -206,7 +206,7 @@ Processes the current batch of items immediately peekAllItems(): TValue[]; ``` -Defined in: [batcher.ts:263](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L263) +Defined in: [batcher.ts:263](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L263) Returns a copy of all items in the batcher @@ -222,7 +222,7 @@ Returns a copy of all items in the batcher reset(): void; ``` -Defined in: [batcher.ts:293](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L293) +Defined in: [batcher.ts:293](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L293) Resets the batcher state to its default values @@ -238,7 +238,7 @@ Resets the batcher state to its default values setOptions(newOptions): void; ``` -Defined in: [batcher.ts:176](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L176) +Defined in: [batcher.ts:176](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L176) Updates the batcher options diff --git a/docs/reference/classes/Debouncer.md b/docs/reference/classes/Debouncer.md index d09f08e31..fdd5e4860 100644 --- a/docs/reference/classes/Debouncer.md +++ b/docs/reference/classes/Debouncer.md @@ -5,7 +5,7 @@ title: Debouncer # Class: Debouncer\ -Defined in: [debouncer.ts:142](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L142) +Defined in: [debouncer.ts:142](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L142) A class that creates a debounced function. @@ -53,7 +53,7 @@ inputElement.addEventListener('input', () => { new Debouncer(fn, initialOptions): Debouncer; ``` -Defined in: [debouncer.ts:150](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L150) +Defined in: [debouncer.ts:150](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L150) #### Parameters @@ -77,7 +77,7 @@ Defined in: [debouncer.ts:150](https://github.com/TanStack/pacer/blob/main/packa fn: TFn; ``` -Defined in: [debouncer.ts:151](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L151) +Defined in: [debouncer.ts:151](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L151) *** @@ -87,7 +87,7 @@ Defined in: [debouncer.ts:151](https://github.com/TanStack/pacer/blob/main/packa key: string | undefined; ``` -Defined in: [debouncer.ts:146](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L146) +Defined in: [debouncer.ts:146](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L146) *** @@ -97,7 +97,7 @@ Defined in: [debouncer.ts:146](https://github.com/TanStack/pacer/blob/main/packa options: DebouncerOptions; ``` -Defined in: [debouncer.ts:147](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L147) +Defined in: [debouncer.ts:147](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L147) *** @@ -107,7 +107,7 @@ Defined in: [debouncer.ts:147](https://github.com/TanStack/pacer/blob/main/packa readonly store: Store>>; ``` -Defined in: [debouncer.ts:143](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L143) +Defined in: [debouncer.ts:143](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L143) ## Methods @@ -117,7 +117,7 @@ Defined in: [debouncer.ts:143](https://github.com/TanStack/pacer/blob/main/packa cancel(): void; ``` -Defined in: [debouncer.ts:283](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L283) +Defined in: [debouncer.ts:283](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L283) Cancels any pending execution @@ -133,7 +133,7 @@ Cancels any pending execution flush(): void; ``` -Defined in: [debouncer.ts:266](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L266) +Defined in: [debouncer.ts:266](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L266) Processes the current pending execution immediately @@ -149,7 +149,7 @@ Processes the current pending execution immediately maybeExecute(...args): void; ``` -Defined in: [debouncer.ts:219](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L219) +Defined in: [debouncer.ts:219](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L219) Attempts to execute the debounced function If a call is already in progress, it will be queued @@ -172,7 +172,7 @@ If a call is already in progress, it will be queued reset(): void; ``` -Defined in: [debouncer.ts:294](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L294) +Defined in: [debouncer.ts:294](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L294) Resets the debouncer state to its default values @@ -188,7 +188,7 @@ Resets the debouncer state to its default values setOptions(newOptions): void; ``` -Defined in: [debouncer.ts:173](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L173) +Defined in: [debouncer.ts:173](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L173) Updates the debouncer options diff --git a/docs/reference/classes/Queuer.md b/docs/reference/classes/Queuer.md index 3cfced503..868d60d71 100644 --- a/docs/reference/classes/Queuer.md +++ b/docs/reference/classes/Queuer.md @@ -5,7 +5,7 @@ title: Queuer # Class: Queuer\ -Defined in: [queuer.ts:269](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L269) +Defined in: [queuer.ts:269](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L269) A flexible queue that processes items with configurable wait times, expiration, and priority. @@ -94,7 +94,7 @@ manualQueue.getNextItem(); // returns 2, queue is empty new Queuer(fn, initialOptions): Queuer; ``` -Defined in: [queuer.ts:277](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L277) +Defined in: [queuer.ts:277](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L277) #### Parameters @@ -118,7 +118,7 @@ Defined in: [queuer.ts:277](https://github.com/TanStack/pacer/blob/main/packages fn: (item) => void; ``` -Defined in: [queuer.ts:278](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L278) +Defined in: [queuer.ts:278](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L278) #### Parameters @@ -138,7 +138,7 @@ Defined in: [queuer.ts:278](https://github.com/TanStack/pacer/blob/main/packages key: string | undefined; ``` -Defined in: [queuer.ts:273](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L273) +Defined in: [queuer.ts:273](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L273) *** @@ -148,7 +148,7 @@ Defined in: [queuer.ts:273](https://github.com/TanStack/pacer/blob/main/packages options: QueuerOptions; ``` -Defined in: [queuer.ts:274](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L274) +Defined in: [queuer.ts:274](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L274) *** @@ -158,7 +158,7 @@ Defined in: [queuer.ts:274](https://github.com/TanStack/pacer/blob/main/packages readonly store: Store>>; ``` -Defined in: [queuer.ts:270](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L270) +Defined in: [queuer.ts:270](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L270) ## Methods @@ -171,7 +171,7 @@ addItem( runOnItemsChange): boolean; ``` -Defined in: [queuer.ts:401](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L401) +Defined in: [queuer.ts:401](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L401) Adds an item to the queue. If the queue is full, the item is rejected and onReject is called. Items can be inserted based on priority or at the front/back depending on configuration. @@ -210,7 +210,7 @@ queuer.addItem('task2', 'front'); clear(): void; ``` -Defined in: [queuer.ts:683](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L683) +Defined in: [queuer.ts:683](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L683) Removes all pending items from the queue. Does not affect items being processed. @@ -226,7 +226,7 @@ Removes all pending items from the queue. Does not affect items being processed. execute(position?): TValue | undefined; ``` -Defined in: [queuer.ts:537](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L537) +Defined in: [queuer.ts:537](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L537) Removes and returns the next item from the queue and processes it using the provided function. @@ -255,7 +255,7 @@ queuer.execute('back'); flush(numberOfItems, position?): void; ``` -Defined in: [queuer.ts:553](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L553) +Defined in: [queuer.ts:553](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L553) Processes a specified number of items to execute immediately with no wait time If no numberOfItems is provided, all items will be processed @@ -282,7 +282,7 @@ If no numberOfItems is provided, all items will be processed flushAsBatch(batchFunction): void; ``` -Defined in: [queuer.ts:568](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L568) +Defined in: [queuer.ts:568](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L568) Processes all items in the queue as a batch using the provided function as an argument The queue is cleared after processing @@ -305,7 +305,7 @@ The queue is cleared after processing getNextItem(position): TValue | undefined; ``` -Defined in: [queuer.ts:485](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L485) +Defined in: [queuer.ts:485](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L485) Removes and returns the next item from the queue without executing the function. Use for manual queue management. Normally, use execute() to process items. @@ -336,7 +336,7 @@ queuer.getNextItem('back'); peekAllItems(): TValue[]; ``` -Defined in: [queuer.ts:651](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L651) +Defined in: [queuer.ts:651](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L651) Returns a copy of all items in the queue. @@ -352,7 +352,7 @@ Returns a copy of all items in the queue. peekNextItem(position): TValue | undefined; ``` -Defined in: [queuer.ts:641](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L641) +Defined in: [queuer.ts:641](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L641) Returns the next item in the queue without removing it. @@ -380,7 +380,7 @@ queuer.peekNextItem('back'); // back reset(): void; ``` -Defined in: [queuer.ts:691](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L691) +Defined in: [queuer.ts:691](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L691) Resets the queuer state to its default values @@ -396,7 +396,7 @@ Resets the queuer state to its default values setOptions(newOptions): void; ``` -Defined in: [queuer.ts:317](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L317) +Defined in: [queuer.ts:317](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L317) Updates the queuer options. New options are merged with existing options. @@ -418,7 +418,7 @@ Updates the queuer options. New options are merged with existing options. start(): void; ``` -Defined in: [queuer.ts:658](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L658) +Defined in: [queuer.ts:658](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L658) Starts processing items in the queue. If already isRunning, does nothing. @@ -434,7 +434,7 @@ Starts processing items in the queue. If already isRunning, does nothing. stop(): void; ``` -Defined in: [queuer.ts:668](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L668) +Defined in: [queuer.ts:668](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L668) Stops processing items in the queue. Does not clear the queue. diff --git a/docs/reference/classes/RateLimiter.md b/docs/reference/classes/RateLimiter.md index 2d4598614..1e2311968 100644 --- a/docs/reference/classes/RateLimiter.md +++ b/docs/reference/classes/RateLimiter.md @@ -5,7 +5,7 @@ title: RateLimiter # Class: RateLimiter\ -Defined in: [rate-limiter.ts:156](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L156) +Defined in: [rate-limiter.ts:156](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L156) A class that creates a rate-limited function. @@ -66,7 +66,7 @@ rateLimiter.maybeExecute('123'); new RateLimiter(fn, initialOptions): RateLimiter; ``` -Defined in: [rate-limiter.ts:163](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L163) +Defined in: [rate-limiter.ts:163](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L163) #### Parameters @@ -90,7 +90,7 @@ Defined in: [rate-limiter.ts:163](https://github.com/TanStack/pacer/blob/main/pa fn: TFn; ``` -Defined in: [rate-limiter.ts:164](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L164) +Defined in: [rate-limiter.ts:164](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L164) *** @@ -100,7 +100,7 @@ Defined in: [rate-limiter.ts:164](https://github.com/TanStack/pacer/blob/main/pa key: string | undefined; ``` -Defined in: [rate-limiter.ts:159](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L159) +Defined in: [rate-limiter.ts:159](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L159) *** @@ -110,7 +110,7 @@ Defined in: [rate-limiter.ts:159](https://github.com/TanStack/pacer/blob/main/pa options: RateLimiterOptions; ``` -Defined in: [rate-limiter.ts:160](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L160) +Defined in: [rate-limiter.ts:160](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L160) *** @@ -120,7 +120,7 @@ Defined in: [rate-limiter.ts:160](https://github.com/TanStack/pacer/blob/main/pa readonly store: Store>; ``` -Defined in: [rate-limiter.ts:157](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L157) +Defined in: [rate-limiter.ts:157](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L157) ## Methods @@ -130,7 +130,7 @@ Defined in: [rate-limiter.ts:157](https://github.com/TanStack/pacer/blob/main/pa getMsUntilNextWindow(): number; ``` -Defined in: [rate-limiter.ts:356](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L356) +Defined in: [rate-limiter.ts:356](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L356) Returns the number of milliseconds until the next execution will be possible @@ -146,7 +146,7 @@ Returns the number of milliseconds until the next execution will be possible getRemainingInWindow(): number; ``` -Defined in: [rate-limiter.ts:348](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L348) +Defined in: [rate-limiter.ts:348](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L348) Returns the number of remaining executions allowed in the current window @@ -162,7 +162,7 @@ Returns the number of remaining executions allowed in the current window maybeExecute(...args): boolean; ``` -Defined in: [rate-limiter.ts:250](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L250) +Defined in: [rate-limiter.ts:250](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L250) Attempts to execute the rate-limited function if within the configured limits. Will reject execution if the number of calls in the current window exceeds the limit. @@ -197,7 +197,7 @@ rateLimiter.maybeExecute('arg1', 'arg2'); // false reset(): void; ``` -Defined in: [rate-limiter.ts:367](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L367) +Defined in: [rate-limiter.ts:367](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L367) Resets the rate limiter state @@ -213,7 +213,7 @@ Resets the rate limiter state setOptions(newOptions): void; ``` -Defined in: [rate-limiter.ts:189](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L189) +Defined in: [rate-limiter.ts:189](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L189) Updates the rate limiter options diff --git a/docs/reference/classes/Throttler.md b/docs/reference/classes/Throttler.md index 6582c976f..23354e359 100644 --- a/docs/reference/classes/Throttler.md +++ b/docs/reference/classes/Throttler.md @@ -5,7 +5,7 @@ title: Throttler # Class: Throttler\ -Defined in: [throttler.ts:150](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L150) +Defined in: [throttler.ts:150](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L150) A class that creates a throttled function. @@ -57,7 +57,7 @@ throttler.maybeExecute('123'); // Throttled new Throttler(fn, initialOptions): Throttler; ``` -Defined in: [throttler.ts:158](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L158) +Defined in: [throttler.ts:158](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L158) #### Parameters @@ -81,7 +81,7 @@ Defined in: [throttler.ts:158](https://github.com/TanStack/pacer/blob/main/packa fn: TFn; ``` -Defined in: [throttler.ts:159](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L159) +Defined in: [throttler.ts:159](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L159) *** @@ -91,7 +91,7 @@ Defined in: [throttler.ts:159](https://github.com/TanStack/pacer/blob/main/packa key: string | undefined; ``` -Defined in: [throttler.ts:154](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L154) +Defined in: [throttler.ts:154](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L154) *** @@ -101,7 +101,7 @@ Defined in: [throttler.ts:154](https://github.com/TanStack/pacer/blob/main/packa options: ThrottlerOptions; ``` -Defined in: [throttler.ts:155](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L155) +Defined in: [throttler.ts:155](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L155) *** @@ -111,7 +111,7 @@ Defined in: [throttler.ts:155](https://github.com/TanStack/pacer/blob/main/packa readonly store: Store>>; ``` -Defined in: [throttler.ts:151](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L151) +Defined in: [throttler.ts:151](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L151) ## Methods @@ -121,7 +121,7 @@ Defined in: [throttler.ts:151](https://github.com/TanStack/pacer/blob/main/packa cancel(): void; ``` -Defined in: [throttler.ts:320](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L320) +Defined in: [throttler.ts:320](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L320) Cancels any pending trailing execution and clears internal state. @@ -143,7 +143,7 @@ Has no effect if there is no pending execution. flush(): void; ``` -Defined in: [throttler.ts:298](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L298) +Defined in: [throttler.ts:298](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L298) Processes the current pending execution immediately @@ -159,7 +159,7 @@ Processes the current pending execution immediately maybeExecute(...args): void; ``` -Defined in: [throttler.ts:239](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L239) +Defined in: [throttler.ts:239](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L239) Attempts to execute the throttled function. The execution behavior depends on the throttler options: @@ -201,7 +201,7 @@ throttled.maybeExecute('c', 'd'); reset(): void; ``` -Defined in: [throttler.ts:331](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L331) +Defined in: [throttler.ts:331](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L331) Resets the throttler state to its default values @@ -217,7 +217,7 @@ Resets the throttler state to its default values setOptions(newOptions): void; ``` -Defined in: [throttler.ts:181](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L181) +Defined in: [throttler.ts:181](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L181) Updates the throttler options diff --git a/docs/reference/functions/asyncBatch.md b/docs/reference/functions/asyncBatch.md index 5759b8567..3f8f1c97c 100644 --- a/docs/reference/functions/asyncBatch.md +++ b/docs/reference/functions/asyncBatch.md @@ -9,7 +9,7 @@ title: asyncBatch function asyncBatch(fn, options): (item) => Promise; ``` -Defined in: [async-batcher.ts:584](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L584) +Defined in: [async-batcher.ts:584](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L584) Creates an async batcher that processes items in batches. diff --git a/docs/reference/functions/asyncBatcherOptions.md b/docs/reference/functions/asyncBatcherOptions.md index 4685eb358..53a6322d7 100644 --- a/docs/reference/functions/asyncBatcherOptions.md +++ b/docs/reference/functions/asyncBatcherOptions.md @@ -9,7 +9,7 @@ title: asyncBatcherOptions function asyncBatcherOptions(options): TOptions; ``` -Defined in: [async-batcher.ts:168](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L168) +Defined in: [async-batcher.ts:168](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L168) Utility function for sharing common `AsyncBatcherOptions` options between different `AsyncBatcher` instances. diff --git a/docs/reference/functions/asyncDebounce.md b/docs/reference/functions/asyncDebounce.md index 7c35c45e4..fd32d52af 100644 --- a/docs/reference/functions/asyncDebounce.md +++ b/docs/reference/functions/asyncDebounce.md @@ -6,10 +6,10 @@ title: asyncDebounce # Function: asyncDebounce() ```ts -function asyncDebounce(fn, initialOptions): (...args) => Promise | undefined>; +function asyncDebounce(fn, initialOptions): (...args) => Promise> | undefined>; ``` -Defined in: [async-debouncer.ts:555](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L555) +Defined in: [async-debouncer.ts:555](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L555) Creates an async debounced function that delays execution until after a specified wait time. The debounced function will only execute once the wait period has elapsed without any new calls. @@ -75,7 +75,7 @@ State Management: ## Returns ```ts -(...args): Promise | undefined>; +(...args): Promise> | undefined>; ``` Attempts to execute the debounced function. @@ -96,7 +96,7 @@ Error Handling: ### Returns -`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\> A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError diff --git a/docs/reference/functions/asyncDebouncerOptions.md b/docs/reference/functions/asyncDebouncerOptions.md index d46268c51..82b1d7997 100644 --- a/docs/reference/functions/asyncDebouncerOptions.md +++ b/docs/reference/functions/asyncDebouncerOptions.md @@ -9,7 +9,7 @@ title: asyncDebouncerOptions function asyncDebouncerOptions(options): TOptions; ``` -Defined in: [async-debouncer.ts:140](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L140) +Defined in: [async-debouncer.ts:140](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L140) Utility function for sharing common `AsyncDebouncerOptions` options between different `AsyncDebouncer` instances. diff --git a/docs/reference/functions/asyncQueue.md b/docs/reference/functions/asyncQueue.md index 62ad83b84..1cd17d23a 100644 --- a/docs/reference/functions/asyncQueue.md +++ b/docs/reference/functions/asyncQueue.md @@ -9,7 +9,7 @@ title: asyncQueue function asyncQueue(fn, initialOptions): (item, position, runOnItemsChange) => boolean; ``` -Defined in: [async-queuer.ts:915](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L915) +Defined in: [async-queuer.ts:915](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L915) Creates a new AsyncQueuer instance and returns a bound addItem function for adding tasks. The queuer is started automatically and ready to process items. diff --git a/docs/reference/functions/asyncQueuerOptions.md b/docs/reference/functions/asyncQueuerOptions.md index 3552b9528..4d55059c7 100644 --- a/docs/reference/functions/asyncQueuerOptions.md +++ b/docs/reference/functions/asyncQueuerOptions.md @@ -9,7 +9,7 @@ title: asyncQueuerOptions function asyncQueuerOptions(options): TOptions; ``` -Defined in: [async-queuer.ts:213](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L213) +Defined in: [async-queuer.ts:213](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L213) Utility function for sharing common `AsyncQueuerOptions` options between different `AsyncQueuer` instances. diff --git a/docs/reference/functions/asyncRateLimit.md b/docs/reference/functions/asyncRateLimit.md index 7f9c08824..d562eeedd 100644 --- a/docs/reference/functions/asyncRateLimit.md +++ b/docs/reference/functions/asyncRateLimit.md @@ -6,10 +6,10 @@ title: asyncRateLimit # Function: asyncRateLimit() ```ts -function asyncRateLimit(fn, initialOptions): (...args) => Promise | undefined>; +function asyncRateLimit(fn, initialOptions): (...args) => Promise> | undefined>; ``` -Defined in: [async-rate-limiter.ts:637](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L637) +Defined in: [async-rate-limiter.ts:637](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L637) Creates an async rate-limited function that will execute the provided function up to a maximum number of times within a time window. @@ -89,7 +89,7 @@ State Management: ## Returns ```ts -(...args): Promise | undefined>; +(...args): Promise> | undefined>; ``` Attempts to execute the rate-limited function if within the configured limits. @@ -110,7 +110,7 @@ Error Handling: ### Returns -`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\> A promise that resolves with the function's return value, or undefined if an error occurred and was handled by onError diff --git a/docs/reference/functions/asyncRateLimiterOptions.md b/docs/reference/functions/asyncRateLimiterOptions.md index 7844038ab..791724c92 100644 --- a/docs/reference/functions/asyncRateLimiterOptions.md +++ b/docs/reference/functions/asyncRateLimiterOptions.md @@ -9,7 +9,7 @@ title: asyncRateLimiterOptions function asyncRateLimiterOptions(options): TOptions; ``` -Defined in: [async-rate-limiter.ts:148](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L148) +Defined in: [async-rate-limiter.ts:148](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L148) Utility function for sharing common `AsyncRateLimiterOptions` options between different `AsyncRateLimiter` instances. diff --git a/docs/reference/functions/asyncRetry.md b/docs/reference/functions/asyncRetry.md index 87a29a57a..402bdaa19 100644 --- a/docs/reference/functions/asyncRetry.md +++ b/docs/reference/functions/asyncRetry.md @@ -9,7 +9,7 @@ title: asyncRetry function asyncRetry(fn, initialOptions): (...args) => Promise> | undefined>; ``` -Defined in: [async-retryer.ts:674](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L674) +Defined in: [async-retryer.ts:674](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L674) Creates a retry-enabled version of an async function. This is a convenience wrapper around the AsyncRetryer class that returns the execute method. diff --git a/docs/reference/functions/asyncRetryerOptions.md b/docs/reference/functions/asyncRetryerOptions.md index b9b602649..e3bd0d2f5 100644 --- a/docs/reference/functions/asyncRetryerOptions.md +++ b/docs/reference/functions/asyncRetryerOptions.md @@ -9,7 +9,7 @@ title: asyncRetryerOptions function asyncRetryerOptions(options): TOptions; ``` -Defined in: [async-retryer.ts:169](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L169) +Defined in: [async-retryer.ts:169](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L169) Utility function for sharing common `AsyncRetryerOptions` options between different `AsyncRetryer` instances. diff --git a/docs/reference/functions/asyncThrottle.md b/docs/reference/functions/asyncThrottle.md index 6daf7011e..1e4a1c59e 100644 --- a/docs/reference/functions/asyncThrottle.md +++ b/docs/reference/functions/asyncThrottle.md @@ -6,10 +6,10 @@ title: asyncThrottle # Function: asyncThrottle() ```ts -function asyncThrottle(fn, initialOptions): (...args) => Promise | undefined>; +function asyncThrottle(fn, initialOptions): (...args) => Promise> | undefined>; ``` -Defined in: [async-throttler.ts:623](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L623) +Defined in: [async-throttler.ts:625](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L625) Creates an async throttled function that limits how often the function can execute. The throttled function will execute at most once per wait period, even if called multiple times. @@ -76,7 +76,7 @@ State Management: ## Returns ```ts -(...args): Promise | undefined>; +(...args): Promise> | undefined>; ``` Attempts to execute the throttled function. The execution behavior depends on the throttler options: @@ -97,7 +97,7 @@ Attempts to execute the throttled function. The execution behavior depends on th ### Returns -`Promise`\<`ReturnType`\<`TFn`\> \| `undefined`\> +`Promise`\<`Awaited`\<`ReturnType`\<`TFn`\>\> \| `undefined`\> ### Example diff --git a/docs/reference/functions/asyncThrottlerOptions.md b/docs/reference/functions/asyncThrottlerOptions.md index f6ac41200..f729ccf0f 100644 --- a/docs/reference/functions/asyncThrottlerOptions.md +++ b/docs/reference/functions/asyncThrottlerOptions.md @@ -9,7 +9,7 @@ title: asyncThrottlerOptions function asyncThrottlerOptions(options): TOptions; ``` -Defined in: [async-throttler.ts:148](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L148) +Defined in: [async-throttler.ts:148](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L148) Utility function for sharing common `AsyncThrottlerOptions` options between different `AsyncThrottler` instances. diff --git a/docs/reference/functions/batch.md b/docs/reference/functions/batch.md index 5200ddeea..a9a4e3f19 100644 --- a/docs/reference/functions/batch.md +++ b/docs/reference/functions/batch.md @@ -9,7 +9,7 @@ title: batch function batch(fn, options): (item) => void; ``` -Defined in: [batcher.ts:319](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L319) +Defined in: [batcher.ts:319](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L319) Creates a batcher that processes items in batches. diff --git a/docs/reference/functions/debounce.md b/docs/reference/functions/debounce.md index ae762ec84..b635eee3d 100644 --- a/docs/reference/functions/debounce.md +++ b/docs/reference/functions/debounce.md @@ -9,7 +9,7 @@ title: debounce function debounce(fn, initialOptions): (...args) => void; ``` -Defined in: [debouncer.ts:326](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L326) +Defined in: [debouncer.ts:326](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L326) Creates a debounced function that delays invoking the provided function until after a specified wait time. Multiple calls during the wait period will cancel previous pending invocations and reset the timer. diff --git a/docs/reference/functions/debouncerOptions.md b/docs/reference/functions/debouncerOptions.md index 1cf0f44f2..6da6f76cd 100644 --- a/docs/reference/functions/debouncerOptions.md +++ b/docs/reference/functions/debouncerOptions.md @@ -9,7 +9,7 @@ title: debouncerOptions function debouncerOptions(options): TOptions; ``` -Defined in: [debouncer.ts:91](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L91) +Defined in: [debouncer.ts:91](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L91) Utility function for sharing common `DebouncerOptions` options between different `Debouncer` instances. diff --git a/docs/reference/functions/isFunction.md b/docs/reference/functions/isFunction.md index 1f0215538..e1190495d 100644 --- a/docs/reference/functions/isFunction.md +++ b/docs/reference/functions/isFunction.md @@ -9,7 +9,7 @@ title: isFunction function isFunction(value): value is T; ``` -Defined in: [utils.ts:3](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/utils.ts#L3) +Defined in: [utils.ts:3](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/utils.ts#L3) ## Type Parameters diff --git a/docs/reference/functions/parseFunctionOrValue.md b/docs/reference/functions/parseFunctionOrValue.md index 04867841f..2f3baf970 100644 --- a/docs/reference/functions/parseFunctionOrValue.md +++ b/docs/reference/functions/parseFunctionOrValue.md @@ -9,7 +9,7 @@ title: parseFunctionOrValue function parseFunctionOrValue(value, ...args): T; ``` -Defined in: [utils.ts:7](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/utils.ts#L7) +Defined in: [utils.ts:7](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/utils.ts#L7) ## Type Parameters diff --git a/docs/reference/functions/queue.md b/docs/reference/functions/queue.md index 5a9ab949e..cb99677dd 100644 --- a/docs/reference/functions/queue.md +++ b/docs/reference/functions/queue.md @@ -9,7 +9,7 @@ title: queue function queue(fn, initialOptions): (item, position, runOnItemsChange) => boolean; ``` -Defined in: [queuer.ts:732](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L732) +Defined in: [queuer.ts:732](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L732) Creates a queue that processes items immediately upon addition. Items are processed sequentially in FIFO order by default. diff --git a/docs/reference/functions/queuerOptions.md b/docs/reference/functions/queuerOptions.md index d98efeb1a..052a5b3cd 100644 --- a/docs/reference/functions/queuerOptions.md +++ b/docs/reference/functions/queuerOptions.md @@ -9,7 +9,7 @@ title: queuerOptions function queuerOptions(options): TOptions; ``` -Defined in: [queuer.ts:157](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L157) +Defined in: [queuer.ts:157](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L157) Utility function for sharing common `QueuerOptions` options between different `Queuer` instances. diff --git a/docs/reference/functions/rateLimit.md b/docs/reference/functions/rateLimit.md index f73cc067a..5cfb84a1b 100644 --- a/docs/reference/functions/rateLimit.md +++ b/docs/reference/functions/rateLimit.md @@ -9,7 +9,7 @@ title: rateLimit function rateLimit(fn, initialOptions): (...args) => boolean; ``` -Defined in: [rate-limiter.ts:421](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L421) +Defined in: [rate-limiter.ts:421](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L421) Creates a rate-limited function that will execute the provided function up to a maximum number of times within a time window. diff --git a/docs/reference/functions/rateLimiterOptions.md b/docs/reference/functions/rateLimiterOptions.md index 01e8445f1..cf6438f58 100644 --- a/docs/reference/functions/rateLimiterOptions.md +++ b/docs/reference/functions/rateLimiterOptions.md @@ -9,7 +9,7 @@ title: rateLimiterOptions function rateLimiterOptions(options): TOptions; ``` -Defined in: [rate-limiter.ts:92](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L92) +Defined in: [rate-limiter.ts:92](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L92) Utility function for sharing common `RateLimiterOptions` options between different `RateLimiter` instances. diff --git a/docs/reference/functions/throttle.md b/docs/reference/functions/throttle.md index d51a71373..a9aa6e794 100644 --- a/docs/reference/functions/throttle.md +++ b/docs/reference/functions/throttle.md @@ -9,7 +9,7 @@ title: throttle function throttle(fn, initialOptions): (...args) => void; ``` -Defined in: [throttler.ts:372](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L372) +Defined in: [throttler.ts:372](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L372) Creates a throttled function that limits how often the provided function can execute. diff --git a/docs/reference/functions/throttlerOptions.md b/docs/reference/functions/throttlerOptions.md index 3f7d13d8b..cbe3057a7 100644 --- a/docs/reference/functions/throttlerOptions.md +++ b/docs/reference/functions/throttlerOptions.md @@ -9,7 +9,7 @@ title: throttlerOptions function throttlerOptions(options): TOptions; ``` -Defined in: [throttler.ts:95](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L95) +Defined in: [throttler.ts:95](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L95) Utility function for sharing common `ThrottlerOptions` options between different `Throttler` instances. diff --git a/docs/reference/interfaces/AsyncBatcherOptions.md b/docs/reference/interfaces/AsyncBatcherOptions.md index d50227c5c..2885571ee 100644 --- a/docs/reference/interfaces/AsyncBatcherOptions.md +++ b/docs/reference/interfaces/AsyncBatcherOptions.md @@ -5,7 +5,7 @@ title: AsyncBatcherOptions # Interface: AsyncBatcherOptions\ -Defined in: [async-batcher.ts:89](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L89) +Defined in: [async-batcher.ts:89](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L89) Options for configuring an AsyncBatcher instance @@ -23,7 +23,7 @@ Options for configuring an AsyncBatcher instance optional asyncRetryerOptions: AsyncRetryerOptions<(items) => Promise>; ``` -Defined in: [async-batcher.ts:93](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L93) +Defined in: [async-batcher.ts:93](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L93) Options for configuring the underlying async retryer @@ -35,7 +35,7 @@ Options for configuring the underlying async retryer optional getShouldExecute: (items, batcher) => boolean; ``` -Defined in: [async-batcher.ts:100](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L100) +Defined in: [async-batcher.ts:100](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L100) Custom function to determine if a batch should be processed Return true to process the batch immediately @@ -62,7 +62,7 @@ Return true to process the batch immediately optional initialState: Partial>; ``` -Defined in: [async-batcher.ts:107](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L107) +Defined in: [async-batcher.ts:107](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L107) Initial state for the async batcher @@ -74,7 +74,7 @@ Initial state for the async batcher optional key: string; ``` -Defined in: [async-batcher.ts:112](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L112) +Defined in: [async-batcher.ts:112](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L112) Optional key to identify this async batcher instance. If provided, the async batcher will be identified by this key in the devtools and PacerProvider if applicable. @@ -87,7 +87,7 @@ If provided, the async batcher will be identified by this key in the devtools an optional maxSize: number; ``` -Defined in: [async-batcher.ts:117](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L117) +Defined in: [async-batcher.ts:117](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L117) Maximum number of items in a batch @@ -105,7 +105,7 @@ Infinity optional onError: (error, batch, batcher) => void; ``` -Defined in: [async-batcher.ts:123](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L123) +Defined in: [async-batcher.ts:123](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L123) Optional error handler for when the batch function throws. If provided, the handler will be called with the error, the batch of items that failed, and batcher instance. @@ -137,7 +137,7 @@ This can be used alongside throwOnError - the handler will be called before any optional onItemsChange: (batcher) => void; ``` -Defined in: [async-batcher.ts:131](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L131) +Defined in: [async-batcher.ts:131](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L131) Callback fired after items are added to the batcher @@ -159,7 +159,7 @@ Callback fired after items are added to the batcher optional onSettled: (batch, batcher) => void; ``` -Defined in: [async-batcher.ts:135](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L135) +Defined in: [async-batcher.ts:135](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L135) Optional callback to call when a batch is settled (completed or failed) @@ -185,7 +185,7 @@ Optional callback to call when a batch is settled (completed or failed) optional onSuccess: (result, batch, batcher) => void; ``` -Defined in: [async-batcher.ts:139](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L139) +Defined in: [async-batcher.ts:139](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L139) Optional callback to call when a batch succeeds @@ -215,7 +215,7 @@ Optional callback to call when a batch succeeds optional started: boolean; ``` -Defined in: [async-batcher.ts:148](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L148) +Defined in: [async-batcher.ts:148](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L148) Whether the batcher should start processing immediately @@ -233,7 +233,7 @@ true optional throwOnError: boolean; ``` -Defined in: [async-batcher.ts:154](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L154) +Defined in: [async-batcher.ts:154](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L154) Whether to throw errors when they occur. Defaults to true if no onError handler is provided, false if an onError handler is provided. @@ -247,7 +247,7 @@ Can be explicitly set to override these defaults. optional wait: number | (asyncBatcher) => number; ``` -Defined in: [async-batcher.ts:161](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L161) +Defined in: [async-batcher.ts:161](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L161) Maximum time in milliseconds to wait before processing a batch. If the wait duration has elapsed, the batch will be processed. diff --git a/docs/reference/interfaces/AsyncBatcherState.md b/docs/reference/interfaces/AsyncBatcherState.md index 844d89f05..0d2e9d137 100644 --- a/docs/reference/interfaces/AsyncBatcherState.md +++ b/docs/reference/interfaces/AsyncBatcherState.md @@ -5,7 +5,7 @@ title: AsyncBatcherState # Interface: AsyncBatcherState\ -Defined in: [async-batcher.ts:8](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L8) +Defined in: [async-batcher.ts:8](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L8) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [async-batcher.ts:8](https://github.com/TanStack/pacer/blob/main/pac errorCount: number; ``` -Defined in: [async-batcher.ts:12](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L12) +Defined in: [async-batcher.ts:12](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L12) Number of batch executions that have resulted in errors @@ -33,7 +33,7 @@ Number of batch executions that have resulted in errors executeCount: number; ``` -Defined in: [async-batcher.ts:16](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L16) +Defined in: [async-batcher.ts:16](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L16) Number of batch executions that have been executed @@ -45,7 +45,7 @@ Number of batch executions that have been executed failedItems: TValue[]; ``` -Defined in: [async-batcher.ts:20](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L20) +Defined in: [async-batcher.ts:20](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L20) Array of items that failed during batch processing @@ -57,7 +57,7 @@ Array of items that failed during batch processing isEmpty: boolean; ``` -Defined in: [async-batcher.ts:24](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L24) +Defined in: [async-batcher.ts:24](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L24) Whether the batcher has no items to process (items array is empty) @@ -69,7 +69,7 @@ Whether the batcher has no items to process (items array is empty) isExecuting: boolean; ``` -Defined in: [async-batcher.ts:28](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L28) +Defined in: [async-batcher.ts:28](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L28) Whether a batch is currently being processed asynchronously @@ -81,7 +81,7 @@ Whether a batch is currently being processed asynchronously isPending: boolean; ``` -Defined in: [async-batcher.ts:32](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L32) +Defined in: [async-batcher.ts:32](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L32) Whether the batcher is waiting for the timeout to trigger batch processing @@ -93,7 +93,7 @@ Whether the batcher is waiting for the timeout to trigger batch processing items: TValue[]; ``` -Defined in: [async-batcher.ts:36](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L36) +Defined in: [async-batcher.ts:36](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L36) Array of items currently queued for batch processing @@ -105,7 +105,7 @@ Array of items currently queued for batch processing lastResult: any; ``` -Defined in: [async-batcher.ts:40](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L40) +Defined in: [async-batcher.ts:40](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L40) The result from the most recent batch execution @@ -117,7 +117,7 @@ The result from the most recent batch execution settleCount: number; ``` -Defined in: [async-batcher.ts:44](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L44) +Defined in: [async-batcher.ts:44](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L44) Number of batch executions that have completed (either successfully or with errors) @@ -129,7 +129,7 @@ Number of batch executions that have completed (either successfully or with erro size: number; ``` -Defined in: [async-batcher.ts:48](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L48) +Defined in: [async-batcher.ts:48](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L48) Number of items currently in the batch queue @@ -141,7 +141,7 @@ Number of items currently in the batch queue status: "idle" | "pending" | "executing" | "populated"; ``` -Defined in: [async-batcher.ts:52](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L52) +Defined in: [async-batcher.ts:52](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L52) Current processing status - 'idle' when not processing, 'pending' when waiting for timeout, 'executing' when processing, 'populated' when items are present, but no wait is configured @@ -153,7 +153,7 @@ Current processing status - 'idle' when not processing, 'pending' when waiting f successCount: number; ``` -Defined in: [async-batcher.ts:56](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L56) +Defined in: [async-batcher.ts:56](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L56) Number of batch executions that have completed successfully @@ -165,7 +165,7 @@ Number of batch executions that have completed successfully totalItemsFailed: number; ``` -Defined in: [async-batcher.ts:60](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L60) +Defined in: [async-batcher.ts:60](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L60) Total number of items that have failed processing across all batches @@ -177,6 +177,6 @@ Total number of items that have failed processing across all batches totalItemsProcessed: number; ``` -Defined in: [async-batcher.ts:64](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-batcher.ts#L64) +Defined in: [async-batcher.ts:64](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-batcher.ts#L64) Total number of items that have been processed across all batches diff --git a/docs/reference/interfaces/AsyncDebouncerOptions.md b/docs/reference/interfaces/AsyncDebouncerOptions.md index d41642fc3..29ef034a2 100644 --- a/docs/reference/interfaces/AsyncDebouncerOptions.md +++ b/docs/reference/interfaces/AsyncDebouncerOptions.md @@ -5,7 +5,7 @@ title: AsyncDebouncerOptions # Interface: AsyncDebouncerOptions\ -Defined in: [async-debouncer.ts:71](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L71) +Defined in: [async-debouncer.ts:71](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L71) Options for configuring an async debounced function @@ -23,7 +23,7 @@ Options for configuring an async debounced function optional asyncRetryerOptions: AsyncRetryerOptions; ``` -Defined in: [async-debouncer.ts:75](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L75) +Defined in: [async-debouncer.ts:75](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L75) Options for configuring the underlying async retryer @@ -35,7 +35,7 @@ Options for configuring the underlying async retryer optional enabled: boolean | (debouncer) => boolean; ``` -Defined in: [async-debouncer.ts:81](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L81) +Defined in: [async-debouncer.ts:81](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L81) Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions. Can be a boolean or a function that returns a boolean. @@ -49,7 +49,7 @@ Defaults to true. optional initialState: Partial>; ``` -Defined in: [async-debouncer.ts:85](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L85) +Defined in: [async-debouncer.ts:85](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L85) Initial state for the async debouncer @@ -61,7 +61,7 @@ Initial state for the async debouncer optional key: string; ``` -Defined in: [async-debouncer.ts:90](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L90) +Defined in: [async-debouncer.ts:90](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L90) Optional key to identify this async debouncer instance. If provided, the async debouncer will be identified by this key in the devtools and PacerProvider if applicable. @@ -74,7 +74,7 @@ If provided, the async debouncer will be identified by this key in the devtools optional leading: boolean; ``` -Defined in: [async-debouncer.ts:95](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L95) +Defined in: [async-debouncer.ts:95](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L95) Whether to execute on the leading edge of the timeout. Defaults to false. @@ -87,7 +87,7 @@ Defaults to false. optional onError: (error, args, debouncer) => void; ``` -Defined in: [async-debouncer.ts:101](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L101) +Defined in: [async-debouncer.ts:101](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L101) Optional error handler for when the debounced function throws. If provided, the handler will be called with the error and debouncer instance. @@ -119,7 +119,7 @@ This can be used alongside throwOnError - the handler will be called before any optional onSettled: (args, debouncer) => void; ``` -Defined in: [async-debouncer.ts:109](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L109) +Defined in: [async-debouncer.ts:109](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L109) Optional callback to call when the debounced function is executed @@ -145,7 +145,7 @@ Optional callback to call when the debounced function is executed optional onSuccess: (result, args, debouncer) => void; ``` -Defined in: [async-debouncer.ts:113](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L113) +Defined in: [async-debouncer.ts:113](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L113) Optional callback to call when the debounced function is executed @@ -153,7 +153,7 @@ Optional callback to call when the debounced function is executed ##### result -`ReturnType`\<`TFn`\> +`Awaited`\<`ReturnType`\<`TFn`\>\> ##### args @@ -175,7 +175,7 @@ Optional callback to call when the debounced function is executed optional throwOnError: boolean; ``` -Defined in: [async-debouncer.ts:123](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L123) +Defined in: [async-debouncer.ts:123](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L123) Whether to throw errors when they occur. Defaults to true if no onError handler is provided, false if an onError handler is provided. @@ -189,7 +189,7 @@ Can be explicitly set to override these defaults. optional trailing: boolean; ``` -Defined in: [async-debouncer.ts:128](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L128) +Defined in: [async-debouncer.ts:128](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L128) Whether to execute on the trailing edge of the timeout. Defaults to true. @@ -202,7 +202,7 @@ Defaults to true. wait: number | (debouncer) => number; ``` -Defined in: [async-debouncer.ts:134](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L134) +Defined in: [async-debouncer.ts:134](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L134) Delay in milliseconds to wait after the last call before executing. Can be a number or a function that returns a number. diff --git a/docs/reference/interfaces/AsyncDebouncerState.md b/docs/reference/interfaces/AsyncDebouncerState.md index f2d2fcb74..d0ab36e54 100644 --- a/docs/reference/interfaces/AsyncDebouncerState.md +++ b/docs/reference/interfaces/AsyncDebouncerState.md @@ -5,7 +5,7 @@ title: AsyncDebouncerState # Interface: AsyncDebouncerState\ -Defined in: [async-debouncer.ts:8](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L8) +Defined in: [async-debouncer.ts:8](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L8) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [async-debouncer.ts:8](https://github.com/TanStack/pacer/blob/main/p canLeadingExecute: boolean; ``` -Defined in: [async-debouncer.ts:12](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L12) +Defined in: [async-debouncer.ts:12](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L12) Whether the debouncer can execute on the leading edge of the timeout @@ -33,7 +33,7 @@ Whether the debouncer can execute on the leading edge of the timeout errorCount: number; ``` -Defined in: [async-debouncer.ts:16](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L16) +Defined in: [async-debouncer.ts:16](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L16) Number of function executions that have resulted in errors @@ -45,7 +45,7 @@ Number of function executions that have resulted in errors isExecuting: boolean; ``` -Defined in: [async-debouncer.ts:20](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L20) +Defined in: [async-debouncer.ts:20](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L20) Whether the debounced function is currently executing asynchronously @@ -57,7 +57,7 @@ Whether the debounced function is currently executing asynchronously isPending: boolean; ``` -Defined in: [async-debouncer.ts:24](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L24) +Defined in: [async-debouncer.ts:24](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L24) Whether the debouncer is waiting for the timeout to trigger execution @@ -69,7 +69,7 @@ Whether the debouncer is waiting for the timeout to trigger execution lastArgs: Parameters | undefined; ``` -Defined in: [async-debouncer.ts:28](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L28) +Defined in: [async-debouncer.ts:28](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L28) The arguments from the most recent call to maybeExecute @@ -78,10 +78,10 @@ The arguments from the most recent call to maybeExecute ### lastResult ```ts -lastResult: ReturnType | undefined; +lastResult: Awaited> | undefined; ``` -Defined in: [async-debouncer.ts:32](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L32) +Defined in: [async-debouncer.ts:32](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L32) The result from the most recent successful function execution @@ -93,7 +93,7 @@ The result from the most recent successful function execution maybeExecuteCount: number; ``` -Defined in: [async-debouncer.ts:36](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L36) +Defined in: [async-debouncer.ts:36](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L36) Number of times maybeExecute has been called (for reduction calculations) @@ -105,7 +105,7 @@ Number of times maybeExecute has been called (for reduction calculations) settleCount: number; ``` -Defined in: [async-debouncer.ts:40](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L40) +Defined in: [async-debouncer.ts:40](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L40) Number of function executions that have completed (either successfully or with errors) @@ -117,7 +117,7 @@ Number of function executions that have completed (either successfully or with e status: "disabled" | "idle" | "pending" | "executing" | "settled"; ``` -Defined in: [async-debouncer.ts:44](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L44) +Defined in: [async-debouncer.ts:44](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L44) Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed @@ -129,6 +129,6 @@ Current execution status - 'idle' when not active, 'pending' when waiting, 'exec successCount: number; ``` -Defined in: [async-debouncer.ts:48](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L48) +Defined in: [async-debouncer.ts:48](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L48) Number of function executions that have completed successfully diff --git a/docs/reference/interfaces/AsyncQueuerOptions.md b/docs/reference/interfaces/AsyncQueuerOptions.md index 23ebf1d6b..db543b480 100644 --- a/docs/reference/interfaces/AsyncQueuerOptions.md +++ b/docs/reference/interfaces/AsyncQueuerOptions.md @@ -5,7 +5,7 @@ title: AsyncQueuerOptions # Interface: AsyncQueuerOptions\ -Defined in: [async-queuer.ts:112](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L112) +Defined in: [async-queuer.ts:112](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L112) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [async-queuer.ts:112](https://github.com/TanStack/pacer/blob/main/pa optional addItemsTo: QueuePosition; ``` -Defined in: [async-queuer.ts:121](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L121) +Defined in: [async-queuer.ts:121](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L121) Default position to add items to the queuer @@ -39,7 +39,7 @@ Default position to add items to the queuer optional asyncRetryerOptions: AsyncRetryerOptions<(item) => Promise>; ``` -Defined in: [async-queuer.ts:116](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L116) +Defined in: [async-queuer.ts:116](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L116) Options for configuring the underlying async retryer @@ -51,7 +51,7 @@ Options for configuring the underlying async retryer optional concurrency: number | (queuer) => number; ``` -Defined in: [async-queuer.ts:127](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L127) +Defined in: [async-queuer.ts:127](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L127) Maximum number of concurrent tasks to process. Can be a number or a function that returns a number. @@ -70,7 +70,7 @@ Can be a number or a function that returns a number. optional expirationDuration: number; ``` -Defined in: [async-queuer.ts:132](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L132) +Defined in: [async-queuer.ts:132](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L132) Maximum time in milliseconds that an item can stay in the queue If not provided, items will never expire @@ -83,7 +83,7 @@ If not provided, items will never expire optional getIsExpired: (item, addedAt) => boolean; ``` -Defined in: [async-queuer.ts:137](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L137) +Defined in: [async-queuer.ts:137](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L137) Function to determine if an item has expired If provided, this overrides the expirationDuration behavior @@ -110,7 +110,7 @@ If provided, this overrides the expirationDuration behavior optional getItemsFrom: QueuePosition; ``` -Defined in: [async-queuer.ts:142](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L142) +Defined in: [async-queuer.ts:142](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L142) Default position to get items from during processing @@ -128,7 +128,7 @@ Default position to get items from during processing optional getPriority: (item) => number; ``` -Defined in: [async-queuer.ts:148](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L148) +Defined in: [async-queuer.ts:148](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L148) Function to determine priority of items in the queuer Higher priority items will be processed first @@ -152,7 +152,7 @@ If not provided, will use static priority values attached to tasks optional initialItems: TValue[]; ``` -Defined in: [async-queuer.ts:152](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L152) +Defined in: [async-queuer.ts:152](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L152) Initial items to populate the queuer with @@ -164,7 +164,7 @@ Initial items to populate the queuer with optional initialState: Partial>; ``` -Defined in: [async-queuer.ts:156](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L156) +Defined in: [async-queuer.ts:156](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L156) Initial state for the async queuer @@ -176,7 +176,7 @@ Initial state for the async queuer optional key: string; ``` -Defined in: [async-queuer.ts:161](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L161) +Defined in: [async-queuer.ts:161](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L161) Optional key to identify this async queuer instance. If provided, the async queuer will be identified by this key in the devtools and PacerProvider if applicable. @@ -189,7 +189,7 @@ If provided, the async queuer will be identified by this key in the devtools and optional maxSize: number; ``` -Defined in: [async-queuer.ts:165](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L165) +Defined in: [async-queuer.ts:165](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L165) Maximum number of items allowed in the queuer @@ -201,7 +201,7 @@ Maximum number of items allowed in the queuer optional onError: (error, item, queuer) => void; ``` -Defined in: [async-queuer.ts:171](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L171) +Defined in: [async-queuer.ts:171](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L171) Optional error handler for when a task throws. If provided, the handler will be called with the error and queuer instance. @@ -233,7 +233,7 @@ This can be used alongside throwOnError - the handler will be called before any optional onExpire: (item, queuer) => void; ``` -Defined in: [async-queuer.ts:175](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L175) +Defined in: [async-queuer.ts:175](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L175) Callback fired whenever an item expires in the queuer @@ -259,7 +259,7 @@ Callback fired whenever an item expires in the queuer optional onItemsChange: (queuer) => void; ``` -Defined in: [async-queuer.ts:179](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L179) +Defined in: [async-queuer.ts:179](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L179) Callback fired whenever an item is added or removed from the queuer @@ -281,7 +281,7 @@ Callback fired whenever an item is added or removed from the queuer optional onReject: (item, queuer) => void; ``` -Defined in: [async-queuer.ts:183](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L183) +Defined in: [async-queuer.ts:183](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L183) Callback fired whenever an item is rejected from being added to the queuer @@ -307,7 +307,7 @@ Callback fired whenever an item is rejected from being added to the queuer optional onSettled: (item, queuer) => void; ``` -Defined in: [async-queuer.ts:187](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L187) +Defined in: [async-queuer.ts:187](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L187) Optional callback to call when a task is settled @@ -333,7 +333,7 @@ Optional callback to call when a task is settled optional onSuccess: (result, item, queuer) => void; ``` -Defined in: [async-queuer.ts:191](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L191) +Defined in: [async-queuer.ts:191](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L191) Optional callback to call when a task succeeds @@ -363,7 +363,7 @@ Optional callback to call when a task succeeds optional started: boolean; ``` -Defined in: [async-queuer.ts:195](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L195) +Defined in: [async-queuer.ts:195](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L195) Whether the queuer should start processing tasks immediately or not. @@ -375,7 +375,7 @@ Whether the queuer should start processing tasks immediately or not. optional throwOnError: boolean; ``` -Defined in: [async-queuer.ts:201](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L201) +Defined in: [async-queuer.ts:201](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L201) Whether to throw errors when they occur. Defaults to true if no onError handler is provided, false if an onError handler is provided. @@ -389,7 +389,7 @@ Can be explicitly set to override these defaults. optional wait: number | (queuer) => number; ``` -Defined in: [async-queuer.ts:207](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L207) +Defined in: [async-queuer.ts:207](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L207) Time in milliseconds to wait between processing items. Can be a number or a function that returns a number. diff --git a/docs/reference/interfaces/AsyncQueuerState.md b/docs/reference/interfaces/AsyncQueuerState.md index 2403dcf60..b7fa74721 100644 --- a/docs/reference/interfaces/AsyncQueuerState.md +++ b/docs/reference/interfaces/AsyncQueuerState.md @@ -5,7 +5,7 @@ title: AsyncQueuerState # Interface: AsyncQueuerState\ -Defined in: [async-queuer.ts:9](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L9) +Defined in: [async-queuer.ts:9](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L9) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [async-queuer.ts:9](https://github.com/TanStack/pacer/blob/main/pack activeItems: TValue[]; ``` -Defined in: [async-queuer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L13) +Defined in: [async-queuer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L13) Items currently being processed by the queuer @@ -33,7 +33,7 @@ Items currently being processed by the queuer addItemCount: number; ``` -Defined in: [async-queuer.ts:17](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L17) +Defined in: [async-queuer.ts:17](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L17) Number of times addItem has been called (for reduction calculations) @@ -45,7 +45,7 @@ Number of times addItem has been called (for reduction calculations) errorCount: number; ``` -Defined in: [async-queuer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L21) +Defined in: [async-queuer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L21) Number of task executions that have resulted in errors @@ -57,7 +57,7 @@ Number of task executions that have resulted in errors executeCount: number; ``` -Defined in: [async-queuer.ts:25](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L25) +Defined in: [async-queuer.ts:25](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L25) Number of times execute has been called @@ -69,7 +69,7 @@ Number of times execute has been called expirationCount: number; ``` -Defined in: [async-queuer.ts:29](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L29) +Defined in: [async-queuer.ts:29](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L29) Number of items that have been removed from the queue due to expiration @@ -81,7 +81,7 @@ Number of items that have been removed from the queue due to expiration isEmpty: boolean; ``` -Defined in: [async-queuer.ts:33](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L33) +Defined in: [async-queuer.ts:33](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L33) Whether the queuer has no items to process (items array is empty) @@ -93,7 +93,7 @@ Whether the queuer has no items to process (items array is empty) isExecuting: boolean; ``` -Defined in: [async-queuer.ts:37](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L37) +Defined in: [async-queuer.ts:37](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L37) Whether the queuer is currently executing @@ -105,7 +105,7 @@ Whether the queuer is currently executing isFull: boolean; ``` -Defined in: [async-queuer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L41) +Defined in: [async-queuer.ts:41](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L41) Whether the queuer has reached its maximum capacity @@ -117,7 +117,7 @@ Whether the queuer has reached its maximum capacity isIdle: boolean; ``` -Defined in: [async-queuer.ts:45](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L45) +Defined in: [async-queuer.ts:45](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L45) Whether the queuer is not currently processing any items @@ -129,7 +129,7 @@ Whether the queuer is not currently processing any items isRunning: boolean; ``` -Defined in: [async-queuer.ts:49](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L49) +Defined in: [async-queuer.ts:49](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L49) Whether the queuer is active and will process items automatically @@ -141,7 +141,7 @@ Whether the queuer is active and will process items automatically items: TValue[]; ``` -Defined in: [async-queuer.ts:53](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L53) +Defined in: [async-queuer.ts:53](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L53) Array of items currently waiting to be processed @@ -153,7 +153,7 @@ Array of items currently waiting to be processed itemTimestamps: number[]; ``` -Defined in: [async-queuer.ts:57](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L57) +Defined in: [async-queuer.ts:57](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L57) Timestamps when items were added to the queue for expiration tracking @@ -165,7 +165,7 @@ Timestamps when items were added to the queue for expiration tracking lastResult: any; ``` -Defined in: [async-queuer.ts:61](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L61) +Defined in: [async-queuer.ts:61](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L61) The result from the most recent task execution @@ -177,7 +177,7 @@ The result from the most recent task execution pendingTick: boolean; ``` -Defined in: [async-queuer.ts:65](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L65) +Defined in: [async-queuer.ts:65](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L65) Whether the queuer has a pending timeout for processing the next item @@ -189,7 +189,7 @@ Whether the queuer has a pending timeout for processing the next item rejectionCount: number; ``` -Defined in: [async-queuer.ts:69](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L69) +Defined in: [async-queuer.ts:69](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L69) Number of items that have been rejected from being added to the queue @@ -201,7 +201,7 @@ Number of items that have been rejected from being added to the queue settledCount: number; ``` -Defined in: [async-queuer.ts:73](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L73) +Defined in: [async-queuer.ts:73](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L73) Number of task executions that have completed (either successfully or with errors) @@ -213,7 +213,7 @@ Number of task executions that have completed (either successfully or with error size: number; ``` -Defined in: [async-queuer.ts:77](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L77) +Defined in: [async-queuer.ts:77](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L77) Number of items currently in the queue @@ -225,7 +225,7 @@ Number of items currently in the queue status: "idle" | "running" | "stopped"; ``` -Defined in: [async-queuer.ts:81](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L81) +Defined in: [async-queuer.ts:81](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L81) Current processing status - 'idle' when not processing, 'running' when active, 'stopped' when paused @@ -237,6 +237,6 @@ Current processing status - 'idle' when not processing, 'running' when active, ' successCount: number; ``` -Defined in: [async-queuer.ts:85](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L85) +Defined in: [async-queuer.ts:85](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-queuer.ts#L85) Number of task executions that have completed successfully diff --git a/docs/reference/interfaces/AsyncRateLimiterOptions.md b/docs/reference/interfaces/AsyncRateLimiterOptions.md index 6be480c16..6c4443ac9 100644 --- a/docs/reference/interfaces/AsyncRateLimiterOptions.md +++ b/docs/reference/interfaces/AsyncRateLimiterOptions.md @@ -5,7 +5,7 @@ title: AsyncRateLimiterOptions # Interface: AsyncRateLimiterOptions\ -Defined in: [async-rate-limiter.ts:71](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L71) +Defined in: [async-rate-limiter.ts:71](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L71) Options for configuring an async rate-limited function @@ -23,7 +23,7 @@ Options for configuring an async rate-limited function optional asyncRetryerOptions: AsyncRetryerOptions; ``` -Defined in: [async-rate-limiter.ts:75](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L75) +Defined in: [async-rate-limiter.ts:75](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L75) Options for configuring the underlying async retryer @@ -35,7 +35,7 @@ Options for configuring the underlying async retryer optional enabled: boolean | (rateLimiter) => boolean; ``` -Defined in: [async-rate-limiter.ts:81](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L81) +Defined in: [async-rate-limiter.ts:81](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L81) Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions. Can be a boolean or a function that returns a boolean. @@ -49,7 +49,7 @@ Defaults to true. optional initialState: Partial>; ``` -Defined in: [async-rate-limiter.ts:85](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L85) +Defined in: [async-rate-limiter.ts:85](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L85) Initial state for the rate limiter @@ -61,7 +61,7 @@ Initial state for the rate limiter optional key: string; ``` -Defined in: [async-rate-limiter.ts:90](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L90) +Defined in: [async-rate-limiter.ts:90](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L90) Optional key to identify this async rate limiter instance. If provided, the async rate limiter will be identified by this key in the devtools and PacerProvider if applicable. @@ -74,7 +74,7 @@ If provided, the async rate limiter will be identified by this key in the devtoo limit: number | (rateLimiter) => number; ``` -Defined in: [async-rate-limiter.ts:95](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L95) +Defined in: [async-rate-limiter.ts:95](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L95) Maximum number of executions allowed within the time window. Can be a number or a function that returns a number. @@ -87,7 +87,7 @@ Can be a number or a function that returns a number. optional onError: (error, args, rateLimiter) => void; ``` -Defined in: [async-rate-limiter.ts:101](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L101) +Defined in: [async-rate-limiter.ts:101](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L101) Optional error handler for when the rate-limited function throws. If provided, the handler will be called with the error and rate limiter instance. @@ -119,7 +119,7 @@ This can be used alongside throwOnError - the handler will be called before any optional onReject: (args, rateLimiter) => void; ``` -Defined in: [async-rate-limiter.ts:109](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L109) +Defined in: [async-rate-limiter.ts:109](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L109) Optional callback function that is called when an execution is rejected due to rate limiting @@ -145,7 +145,7 @@ Optional callback function that is called when an execution is rejected due to r optional onSettled: (args, rateLimiter) => void; ``` -Defined in: [async-rate-limiter.ts:113](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L113) +Defined in: [async-rate-limiter.ts:113](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L113) Optional function to call when the rate-limited function is executed @@ -171,7 +171,7 @@ Optional function to call when the rate-limited function is executed optional onSuccess: (result, args, rateLimiter) => void; ``` -Defined in: [async-rate-limiter.ts:120](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L120) +Defined in: [async-rate-limiter.ts:120](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L120) Optional function to call when the rate-limited function is executed @@ -179,7 +179,7 @@ Optional function to call when the rate-limited function is executed ##### result -`ReturnType`\<`TFn`\> +`Awaited`\<`ReturnType`\<`TFn`\>\> ##### args @@ -201,7 +201,7 @@ Optional function to call when the rate-limited function is executed optional throwOnError: boolean; ``` -Defined in: [async-rate-limiter.ts:130](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L130) +Defined in: [async-rate-limiter.ts:130](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L130) Whether to throw errors when they occur. Defaults to true if no onError handler is provided, false if an onError handler is provided. @@ -215,7 +215,7 @@ Can be explicitly set to override these defaults. window: number | (rateLimiter) => number; ``` -Defined in: [async-rate-limiter.ts:135](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L135) +Defined in: [async-rate-limiter.ts:135](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L135) Time window in milliseconds within which the limit applies. Can be a number or a function that returns a number. @@ -228,7 +228,7 @@ Can be a number or a function that returns a number. optional windowType: "fixed" | "sliding"; ``` -Defined in: [async-rate-limiter.ts:142](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L142) +Defined in: [async-rate-limiter.ts:142](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L142) Type of window to use for rate limiting - 'fixed': Uses a fixed window that resets after the window period diff --git a/docs/reference/interfaces/AsyncRateLimiterState.md b/docs/reference/interfaces/AsyncRateLimiterState.md index b39838235..f24001abd 100644 --- a/docs/reference/interfaces/AsyncRateLimiterState.md +++ b/docs/reference/interfaces/AsyncRateLimiterState.md @@ -5,7 +5,7 @@ title: AsyncRateLimiterState # Interface: AsyncRateLimiterState\ -Defined in: [async-rate-limiter.ts:8](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L8) +Defined in: [async-rate-limiter.ts:8](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L8) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [async-rate-limiter.ts:8](https://github.com/TanStack/pacer/blob/mai errorCount: number; ``` -Defined in: [async-rate-limiter.ts:12](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L12) +Defined in: [async-rate-limiter.ts:12](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L12) Number of function executions that have resulted in errors @@ -33,7 +33,7 @@ Number of function executions that have resulted in errors executionTimes: number[]; ``` -Defined in: [async-rate-limiter.ts:16](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L16) +Defined in: [async-rate-limiter.ts:16](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L16) Array of timestamps when executions occurred for rate limiting calculations @@ -45,7 +45,7 @@ Array of timestamps when executions occurred for rate limiting calculations isExceeded: boolean; ``` -Defined in: [async-rate-limiter.ts:20](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L20) +Defined in: [async-rate-limiter.ts:20](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L20) Whether the rate limiter has exceeded the limit @@ -57,7 +57,7 @@ Whether the rate limiter has exceeded the limit isExecuting: boolean; ``` -Defined in: [async-rate-limiter.ts:24](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L24) +Defined in: [async-rate-limiter.ts:24](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L24) Whether the rate-limited function is currently executing asynchronously @@ -66,10 +66,10 @@ Whether the rate-limited function is currently executing asynchronously ### lastResult ```ts -lastResult: ReturnType | undefined; +lastResult: Awaited> | undefined; ``` -Defined in: [async-rate-limiter.ts:28](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L28) +Defined in: [async-rate-limiter.ts:28](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L28) The result from the most recent successful function execution @@ -81,7 +81,7 @@ The result from the most recent successful function execution maybeExecuteCount: number; ``` -Defined in: [async-rate-limiter.ts:48](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L48) +Defined in: [async-rate-limiter.ts:48](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L48) Number of times maybeExecute has been called (for reduction calculations) @@ -93,7 +93,7 @@ Number of times maybeExecute has been called (for reduction calculations) rejectionCount: number; ``` -Defined in: [async-rate-limiter.ts:32](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L32) +Defined in: [async-rate-limiter.ts:32](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L32) Number of function executions that have been rejected due to rate limiting @@ -105,7 +105,7 @@ Number of function executions that have been rejected due to rate limiting settleCount: number; ``` -Defined in: [async-rate-limiter.ts:36](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L36) +Defined in: [async-rate-limiter.ts:36](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L36) Number of function executions that have completed (either successfully or with errors) @@ -117,7 +117,7 @@ Number of function executions that have completed (either successfully or with e status: "disabled" | "idle" | "executing" | "exceeded"; ``` -Defined in: [async-rate-limiter.ts:40](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L40) +Defined in: [async-rate-limiter.ts:40](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L40) Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded @@ -129,6 +129,6 @@ Current execution status - 'disabled' when not active, 'executing' when executin successCount: number; ``` -Defined in: [async-rate-limiter.ts:44](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L44) +Defined in: [async-rate-limiter.ts:44](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-rate-limiter.ts#L44) Number of function executions that have completed successfully diff --git a/docs/reference/interfaces/AsyncRetryerOptions.md b/docs/reference/interfaces/AsyncRetryerOptions.md index e89aad1cc..bd46e1120 100644 --- a/docs/reference/interfaces/AsyncRetryerOptions.md +++ b/docs/reference/interfaces/AsyncRetryerOptions.md @@ -5,7 +5,7 @@ title: AsyncRetryerOptions # Interface: AsyncRetryerOptions\ -Defined in: [async-retryer.ts:60](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L60) +Defined in: [async-retryer.ts:60](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L60) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [async-retryer.ts:60](https://github.com/TanStack/pacer/blob/main/pa optional backoff: "linear" | "exponential" | "fixed"; ``` -Defined in: [async-retryer.ts:68](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L68) +Defined in: [async-retryer.ts:68](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L68) The backoff strategy for retry delays: - 'exponential': Wait time doubles with each attempt (1s, 2s, 4s, ...) @@ -42,7 +42,7 @@ The backoff strategy for retry delays: optional baseWait: number | (retryer) => number; ``` -Defined in: [async-retryer.ts:73](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L73) +Defined in: [async-retryer.ts:73](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L73) Base wait time in milliseconds between retries, or a function that returns the wait time @@ -60,7 +60,7 @@ Base wait time in milliseconds between retries, or a function that returns the w optional enabled: boolean | (retryer) => boolean; ``` -Defined in: [async-retryer.ts:78](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L78) +Defined in: [async-retryer.ts:78](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L78) Whether the retryer is enabled, or a function that determines if it's enabled @@ -78,7 +78,7 @@ true optional initialState: Partial>; ``` -Defined in: [async-retryer.ts:82](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L82) +Defined in: [async-retryer.ts:82](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L82) Initial state to merge with the default state @@ -90,7 +90,7 @@ Initial state to merge with the default state optional jitter: number; ``` -Defined in: [async-retryer.ts:87](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L87) +Defined in: [async-retryer.ts:87](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L87) Jitter percentage to add to retry delays (0-1). Adds randomness to prevent thundering herd. @@ -108,7 +108,7 @@ Jitter percentage to add to retry delays (0-1). Adds randomness to prevent thund optional key: string; ``` -Defined in: [async-retryer.ts:92](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L92) +Defined in: [async-retryer.ts:92](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L92) Optional key to identify this async retryer instance. If provided, the async retryer will be identified by this key in the devtools and PacerProvider if applicable. @@ -121,7 +121,7 @@ If provided, the async retryer will be identified by this key in the devtools an optional maxAttempts: number | (retryer) => number; ``` -Defined in: [async-retryer.ts:97](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L97) +Defined in: [async-retryer.ts:97](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L97) Maximum number of retry attempts, or a function that returns the max attempts @@ -139,7 +139,7 @@ Maximum number of retry attempts, or a function that returns the max attempts optional maxExecutionTime: number; ``` -Defined in: [async-retryer.ts:102](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L102) +Defined in: [async-retryer.ts:102](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L102) Maximum execution time in milliseconds for a single function call before aborting @@ -157,7 +157,7 @@ Infinity optional maxTotalExecutionTime: number; ``` -Defined in: [async-retryer.ts:107](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L107) +Defined in: [async-retryer.ts:107](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L107) Maximum total execution time in milliseconds for the entire retry operation before aborting @@ -175,7 +175,7 @@ Infinity optional maxWait: number | (retryer) => number; ``` -Defined in: [async-retryer.ts:112](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L112) +Defined in: [async-retryer.ts:112](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L112) Maximum wait time in milliseconds to cap retry delays, or a function that returns the max wait time @@ -193,7 +193,7 @@ Infinity optional onAbort: (reason, retryer) => void; ``` -Defined in: [async-retryer.ts:116](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L116) +Defined in: [async-retryer.ts:116](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L116) Callback invoked when the execution is aborted (manually or due to timeouts) @@ -219,7 +219,7 @@ Callback invoked when the execution is aborted (manually or due to timeouts) optional onError: (error, args, retryer) => void; ``` -Defined in: [async-retryer.ts:123](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L123) +Defined in: [async-retryer.ts:123](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L123) Callback invoked when any error occurs during execution (including retries) @@ -249,7 +249,7 @@ Callback invoked when any error occurs during execution (including retries) optional onExecutionTimeout: (retryer) => void; ``` -Defined in: [async-retryer.ts:131](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L131) +Defined in: [async-retryer.ts:131](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L131) Callback invoked when a single execution attempt times out (maxExecutionTime exceeded) @@ -271,7 +271,7 @@ Callback invoked when a single execution attempt times out (maxExecutionTime exc optional onLastError: (error, retryer) => void; ``` -Defined in: [async-retryer.ts:135](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L135) +Defined in: [async-retryer.ts:135](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L135) Callback invoked when the final error occurs after all retries are exhausted @@ -297,7 +297,7 @@ Callback invoked when the final error occurs after all retries are exhausted optional onRetry: (attempt, error, retryer) => void; ``` -Defined in: [async-retryer.ts:139](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L139) +Defined in: [async-retryer.ts:139](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L139) Callback invoked before each retry attempt @@ -327,7 +327,7 @@ Callback invoked before each retry attempt optional onSettled: (args, retryer) => void; ``` -Defined in: [async-retryer.ts:143](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L143) +Defined in: [async-retryer.ts:143](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L143) Callback invoked after execution completes (success or failure) of each attempt @@ -353,7 +353,7 @@ Callback invoked after execution completes (success or failure) of each attempt optional onSuccess: (result, args, retryer) => void; ``` -Defined in: [async-retryer.ts:147](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L147) +Defined in: [async-retryer.ts:147](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L147) Callback invoked when execution succeeds @@ -383,7 +383,7 @@ Callback invoked when execution succeeds optional onTotalExecutionTimeout: (retryer) => void; ``` -Defined in: [async-retryer.ts:155](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L155) +Defined in: [async-retryer.ts:155](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L155) Callback invoked when the total execution time times out (maxTotalExecutionTime exceeded) @@ -405,7 +405,7 @@ Callback invoked when the total execution time times out (maxTotalExecutionTime optional throwOnError: boolean | "last"; ``` -Defined in: [async-retryer.ts:163](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L163) +Defined in: [async-retryer.ts:163](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L163) Controls when errors are thrown: - 'last': Only throw the final error after all retries are exhausted diff --git a/docs/reference/interfaces/AsyncRetryerState.md b/docs/reference/interfaces/AsyncRetryerState.md index 75d501a60..aed3fc25a 100644 --- a/docs/reference/interfaces/AsyncRetryerState.md +++ b/docs/reference/interfaces/AsyncRetryerState.md @@ -5,7 +5,7 @@ title: AsyncRetryerState # Interface: AsyncRetryerState\ -Defined in: [async-retryer.ts:6](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L6) +Defined in: [async-retryer.ts:6](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L6) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [async-retryer.ts:6](https://github.com/TanStack/pacer/blob/main/pac currentAttempt: number; ``` -Defined in: [async-retryer.ts:10](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L10) +Defined in: [async-retryer.ts:10](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L10) The current retry attempt number (0 when not executing) @@ -33,7 +33,7 @@ The current retry attempt number (0 when not executing) executionCount: number; ``` -Defined in: [async-retryer.ts:14](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L14) +Defined in: [async-retryer.ts:14](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L14) Total number of completed executions (successful or failed) @@ -45,7 +45,7 @@ Total number of completed executions (successful or failed) isExecuting: boolean; ``` -Defined in: [async-retryer.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L18) +Defined in: [async-retryer.ts:18](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L18) Whether the retryer is currently executing the function @@ -57,7 +57,7 @@ Whether the retryer is currently executing the function lastError: Error | undefined; ``` -Defined in: [async-retryer.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L22) +Defined in: [async-retryer.ts:22](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L22) The most recent error encountered during execution @@ -69,7 +69,7 @@ The most recent error encountered during execution lastExecutionTime: number; ``` -Defined in: [async-retryer.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L26) +Defined in: [async-retryer.ts:26](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L26) Timestamp of the last execution completion in milliseconds @@ -81,7 +81,7 @@ Timestamp of the last execution completion in milliseconds lastResult: Awaited> | undefined; ``` -Defined in: [async-retryer.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L30) +Defined in: [async-retryer.ts:30](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L30) The result from the most recent successful execution @@ -93,7 +93,7 @@ The result from the most recent successful execution status: "disabled" | "idle" | "executing" | "retrying"; ``` -Defined in: [async-retryer.ts:34](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L34) +Defined in: [async-retryer.ts:34](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L34) Current execution status - 'disabled' when not enabled, 'idle' when ready, 'executing' when running @@ -105,6 +105,6 @@ Current execution status - 'disabled' when not enabled, 'idle' when ready, 'exec totalExecutionTime: number; ``` -Defined in: [async-retryer.ts:38](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-retryer.ts#L38) +Defined in: [async-retryer.ts:38](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-retryer.ts#L38) Total time spent executing (including retries) in milliseconds diff --git a/docs/reference/interfaces/AsyncThrottlerOptions.md b/docs/reference/interfaces/AsyncThrottlerOptions.md index 89efc9974..64841c13c 100644 --- a/docs/reference/interfaces/AsyncThrottlerOptions.md +++ b/docs/reference/interfaces/AsyncThrottlerOptions.md @@ -5,7 +5,7 @@ title: AsyncThrottlerOptions # Interface: AsyncThrottlerOptions\ -Defined in: [async-throttler.ts:76](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L76) +Defined in: [async-throttler.ts:76](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L76) Options for configuring an async throttled function @@ -23,7 +23,7 @@ Options for configuring an async throttled function optional asyncRetryerOptions: AsyncRetryerOptions; ``` -Defined in: [async-throttler.ts:80](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L80) +Defined in: [async-throttler.ts:80](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L80) Options for configuring the underlying async retryer @@ -35,7 +35,7 @@ Options for configuring the underlying async retryer optional enabled: boolean | (throttler) => boolean; ``` -Defined in: [async-throttler.ts:86](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L86) +Defined in: [async-throttler.ts:86](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L86) Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions. Can be a boolean or a function that returns a boolean. @@ -49,7 +49,7 @@ Defaults to true. optional initialState: Partial>; ``` -Defined in: [async-throttler.ts:90](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L90) +Defined in: [async-throttler.ts:90](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L90) Initial state for the async throttler @@ -61,7 +61,7 @@ Initial state for the async throttler optional key: string; ``` -Defined in: [async-throttler.ts:95](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L95) +Defined in: [async-throttler.ts:95](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L95) Optional key to identify this async throttler instance. If provided, the async throttler will be identified by this key in the devtools and PacerProvider if applicable. @@ -74,7 +74,7 @@ If provided, the async throttler will be identified by this key in the devtools optional leading: boolean; ``` -Defined in: [async-throttler.ts:100](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L100) +Defined in: [async-throttler.ts:100](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L100) Whether to execute the function immediately when called Defaults to true @@ -87,7 +87,7 @@ Defaults to true optional onError: (error, args, asyncThrottler) => void; ``` -Defined in: [async-throttler.ts:106](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L106) +Defined in: [async-throttler.ts:106](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L106) Optional error handler for when the throttled function throws. If provided, the handler will be called with the error and throttler instance. @@ -119,7 +119,7 @@ This can be used alongside throwOnError - the handler will be called before any optional onSettled: (args, asyncThrottler) => void; ``` -Defined in: [async-throttler.ts:114](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L114) +Defined in: [async-throttler.ts:114](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L114) Optional function to call when the throttled function is executed @@ -145,7 +145,7 @@ Optional function to call when the throttled function is executed optional onSuccess: (result, args, asyncThrottler) => void; ``` -Defined in: [async-throttler.ts:121](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L121) +Defined in: [async-throttler.ts:121](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L121) Optional function to call when the throttled function is executed @@ -175,7 +175,7 @@ Optional function to call when the throttled function is executed optional throwOnError: boolean; ``` -Defined in: [async-throttler.ts:131](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L131) +Defined in: [async-throttler.ts:131](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L131) Whether to throw errors when they occur. Defaults to true if no onError handler is provided, false if an onError handler is provided. @@ -189,7 +189,7 @@ Can be explicitly set to override these defaults. optional trailing: boolean; ``` -Defined in: [async-throttler.ts:136](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L136) +Defined in: [async-throttler.ts:136](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L136) Whether to execute the function on the trailing edge of the wait period Defaults to true @@ -202,7 +202,7 @@ Defaults to true wait: number | (throttler) => number; ``` -Defined in: [async-throttler.ts:142](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L142) +Defined in: [async-throttler.ts:142](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L142) Time window in milliseconds during which the function can only be executed once. Can be a number or a function that returns a number. diff --git a/docs/reference/interfaces/AsyncThrottlerState.md b/docs/reference/interfaces/AsyncThrottlerState.md index 7989cf8c5..d884d8e5e 100644 --- a/docs/reference/interfaces/AsyncThrottlerState.md +++ b/docs/reference/interfaces/AsyncThrottlerState.md @@ -5,7 +5,7 @@ title: AsyncThrottlerState # Interface: AsyncThrottlerState\ -Defined in: [async-throttler.ts:8](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L8) +Defined in: [async-throttler.ts:8](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L8) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [async-throttler.ts:8](https://github.com/TanStack/pacer/blob/main/p errorCount: number; ``` -Defined in: [async-throttler.ts:12](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L12) +Defined in: [async-throttler.ts:12](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L12) Number of function executions that have resulted in errors @@ -33,7 +33,7 @@ Number of function executions that have resulted in errors isExecuting: boolean; ``` -Defined in: [async-throttler.ts:16](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L16) +Defined in: [async-throttler.ts:16](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L16) Whether the throttled function is currently executing asynchronously @@ -45,7 +45,7 @@ Whether the throttled function is currently executing asynchronously isPending: boolean; ``` -Defined in: [async-throttler.ts:20](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L20) +Defined in: [async-throttler.ts:20](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L20) Whether the throttler is waiting for the timeout to trigger execution @@ -57,7 +57,7 @@ Whether the throttler is waiting for the timeout to trigger execution lastArgs: Parameters | undefined; ``` -Defined in: [async-throttler.ts:24](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L24) +Defined in: [async-throttler.ts:24](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L24) The arguments from the most recent call to maybeExecute @@ -69,7 +69,7 @@ The arguments from the most recent call to maybeExecute lastExecutionTime: number; ``` -Defined in: [async-throttler.ts:28](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L28) +Defined in: [async-throttler.ts:28](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L28) Timestamp of the last function execution in milliseconds @@ -78,10 +78,10 @@ Timestamp of the last function execution in milliseconds ### lastResult ```ts -lastResult: ReturnType | undefined; +lastResult: Awaited> | undefined; ``` -Defined in: [async-throttler.ts:32](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L32) +Defined in: [async-throttler.ts:32](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L32) The result from the most recent successful function execution @@ -93,7 +93,7 @@ The result from the most recent successful function execution maybeExecuteCount: number; ``` -Defined in: [async-throttler.ts:36](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L36) +Defined in: [async-throttler.ts:36](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L36) Number of times maybeExecute has been called (for reduction calculations) @@ -105,7 +105,7 @@ Number of times maybeExecute has been called (for reduction calculations) nextExecutionTime: number | undefined; ``` -Defined in: [async-throttler.ts:40](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L40) +Defined in: [async-throttler.ts:40](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L40) Timestamp when the next execution can occur in milliseconds @@ -117,7 +117,7 @@ Timestamp when the next execution can occur in milliseconds settleCount: number; ``` -Defined in: [async-throttler.ts:44](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L44) +Defined in: [async-throttler.ts:44](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L44) Number of function executions that have completed (either successfully or with errors) @@ -129,7 +129,7 @@ Number of function executions that have completed (either successfully or with e status: "disabled" | "idle" | "pending" | "executing" | "settled"; ``` -Defined in: [async-throttler.ts:48](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L48) +Defined in: [async-throttler.ts:48](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L48) Current execution status - 'idle' when not active, 'pending' when waiting, 'executing' when running, 'settled' when completed @@ -141,6 +141,6 @@ Current execution status - 'idle' when not active, 'pending' when waiting, 'exec successCount: number; ``` -Defined in: [async-throttler.ts:52](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-throttler.ts#L52) +Defined in: [async-throttler.ts:52](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/async-throttler.ts#L52) Number of function executions that have completed successfully diff --git a/docs/reference/interfaces/BatcherOptions.md b/docs/reference/interfaces/BatcherOptions.md index c55269f83..eeeb0d236 100644 --- a/docs/reference/interfaces/BatcherOptions.md +++ b/docs/reference/interfaces/BatcherOptions.md @@ -5,7 +5,7 @@ title: BatcherOptions # Interface: BatcherOptions\ -Defined in: [batcher.ts:52](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L52) +Defined in: [batcher.ts:52](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L52) Options for configuring a Batcher instance @@ -23,7 +23,7 @@ Options for configuring a Batcher instance optional getShouldExecute: (items, batcher) => boolean; ``` -Defined in: [batcher.ts:57](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L57) +Defined in: [batcher.ts:57](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L57) Custom function to determine if a batch should be processed Return true to process the batch immediately @@ -50,7 +50,7 @@ Return true to process the batch immediately optional initialState: Partial>; ``` -Defined in: [batcher.ts:61](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L61) +Defined in: [batcher.ts:61](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L61) Initial state for the batcher @@ -62,7 +62,7 @@ Initial state for the batcher optional key: string; ``` -Defined in: [batcher.ts:66](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L66) +Defined in: [batcher.ts:66](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L66) Optional key to identify this batcher instance. If provided, the batcher will be identified by this key in the devtools and PacerProvider if applicable. @@ -75,7 +75,7 @@ If provided, the batcher will be identified by this key in the devtools and Pace optional maxSize: number; ``` -Defined in: [batcher.ts:71](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L71) +Defined in: [batcher.ts:71](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L71) Maximum number of items in a batch @@ -93,7 +93,7 @@ Infinity optional onExecute: (batch, batcher) => void; ``` -Defined in: [batcher.ts:75](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L75) +Defined in: [batcher.ts:75](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L75) Callback fired after a batch is processed @@ -119,7 +119,7 @@ Callback fired after a batch is processed optional onItemsChange: (batcher) => void; ``` -Defined in: [batcher.ts:79](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L79) +Defined in: [batcher.ts:79](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L79) Callback fired after items are added to the batcher @@ -141,7 +141,7 @@ Callback fired after items are added to the batcher optional started: boolean; ``` -Defined in: [batcher.ts:84](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L84) +Defined in: [batcher.ts:84](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L84) Whether the batcher should start processing immediately @@ -159,7 +159,7 @@ true optional wait: number | (batcher) => number; ``` -Defined in: [batcher.ts:91](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L91) +Defined in: [batcher.ts:91](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L91) Maximum time in milliseconds to wait before processing a batch. If the wait duration has elapsed, the batch will be processed. diff --git a/docs/reference/interfaces/BatcherState.md b/docs/reference/interfaces/BatcherState.md index 495b01020..f4936396a 100644 --- a/docs/reference/interfaces/BatcherState.md +++ b/docs/reference/interfaces/BatcherState.md @@ -5,7 +5,7 @@ title: BatcherState # Interface: BatcherState\ -Defined in: [batcher.ts:6](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L6) +Defined in: [batcher.ts:6](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L6) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [batcher.ts:6](https://github.com/TanStack/pacer/blob/main/packages/ executionCount: number; ``` -Defined in: [batcher.ts:10](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L10) +Defined in: [batcher.ts:10](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L10) Number of batch executions that have been completed @@ -33,7 +33,7 @@ Number of batch executions that have been completed isEmpty: boolean; ``` -Defined in: [batcher.ts:14](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L14) +Defined in: [batcher.ts:14](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L14) Whether the batcher has no items to process (items array is empty) @@ -45,7 +45,7 @@ Whether the batcher has no items to process (items array is empty) isPending: boolean; ``` -Defined in: [batcher.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L18) +Defined in: [batcher.ts:18](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L18) Whether the batcher is waiting for the timeout to trigger batch processing @@ -57,7 +57,7 @@ Whether the batcher is waiting for the timeout to trigger batch processing items: TValue[]; ``` -Defined in: [batcher.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L22) +Defined in: [batcher.ts:22](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L22) Array of items currently queued for batch processing @@ -69,7 +69,7 @@ Array of items currently queued for batch processing size: number; ``` -Defined in: [batcher.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L26) +Defined in: [batcher.ts:26](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L26) Number of items currently in the batch queue @@ -81,7 +81,7 @@ Number of items currently in the batch queue status: "idle" | "pending"; ``` -Defined in: [batcher.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L30) +Defined in: [batcher.ts:30](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L30) Current processing status - 'idle' when not processing, 'pending' when waiting for timeout @@ -93,6 +93,6 @@ Current processing status - 'idle' when not processing, 'pending' when waiting f totalItemsProcessed: number; ``` -Defined in: [batcher.ts:34](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/batcher.ts#L34) +Defined in: [batcher.ts:34](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/batcher.ts#L34) Total number of items that have been processed across all batches diff --git a/docs/reference/interfaces/DebouncerOptions.md b/docs/reference/interfaces/DebouncerOptions.md index 192e1bc13..af18a1e0c 100644 --- a/docs/reference/interfaces/DebouncerOptions.md +++ b/docs/reference/interfaces/DebouncerOptions.md @@ -5,7 +5,7 @@ title: DebouncerOptions # Interface: DebouncerOptions\ -Defined in: [debouncer.ts:49](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L49) +Defined in: [debouncer.ts:49](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L49) Options for configuring a debounced function @@ -23,7 +23,7 @@ Options for configuring a debounced function optional enabled: boolean | (debouncer) => boolean; ``` -Defined in: [debouncer.ts:55](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L55) +Defined in: [debouncer.ts:55](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L55) Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions. Can be a boolean or a function that returns a boolean. @@ -37,7 +37,7 @@ Defaults to true. optional initialState: Partial>; ``` -Defined in: [debouncer.ts:59](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L59) +Defined in: [debouncer.ts:59](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L59) Initial state for the debouncer @@ -49,7 +49,7 @@ Initial state for the debouncer optional key: string; ``` -Defined in: [debouncer.ts:64](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L64) +Defined in: [debouncer.ts:64](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L64) A key to identify the debouncer. If provided, the debouncer will be identified by this key in the devtools and PacerProvider if applicable. @@ -62,7 +62,7 @@ If provided, the debouncer will be identified by this key in the devtools and Pa optional leading: boolean; ``` -Defined in: [debouncer.ts:70](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L70) +Defined in: [debouncer.ts:70](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L70) Whether to execute on the leading edge of the timeout. The first call will execute immediately and the rest will wait the delay. @@ -76,7 +76,7 @@ Defaults to false. optional onExecute: (args, debouncer) => void; ``` -Defined in: [debouncer.ts:74](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L74) +Defined in: [debouncer.ts:74](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L74) Callback function that is called after the function is executed @@ -102,7 +102,7 @@ Callback function that is called after the function is executed optional trailing: boolean; ``` -Defined in: [debouncer.ts:79](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L79) +Defined in: [debouncer.ts:79](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L79) Whether to execute on the trailing edge of the timeout. Defaults to true. @@ -115,7 +115,7 @@ Defaults to true. wait: number | (debouncer) => number; ``` -Defined in: [debouncer.ts:85](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L85) +Defined in: [debouncer.ts:85](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L85) Delay in milliseconds before executing the function. Can be a number or a function that returns a number. diff --git a/docs/reference/interfaces/DebouncerState.md b/docs/reference/interfaces/DebouncerState.md index ed65cd8e0..f85b7a77e 100644 --- a/docs/reference/interfaces/DebouncerState.md +++ b/docs/reference/interfaces/DebouncerState.md @@ -5,7 +5,7 @@ title: DebouncerState # Interface: DebouncerState\ -Defined in: [debouncer.ts:6](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L6) +Defined in: [debouncer.ts:6](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L6) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [debouncer.ts:6](https://github.com/TanStack/pacer/blob/main/package canLeadingExecute: boolean; ``` -Defined in: [debouncer.ts:10](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L10) +Defined in: [debouncer.ts:10](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L10) Whether the debouncer can execute on the leading edge of the timeout @@ -33,7 +33,7 @@ Whether the debouncer can execute on the leading edge of the timeout executionCount: number; ``` -Defined in: [debouncer.ts:14](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L14) +Defined in: [debouncer.ts:14](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L14) Number of function executions that have been completed @@ -45,7 +45,7 @@ Number of function executions that have been completed isPending: boolean; ``` -Defined in: [debouncer.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L18) +Defined in: [debouncer.ts:18](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L18) Whether the debouncer is waiting for the timeout to trigger execution @@ -57,7 +57,7 @@ Whether the debouncer is waiting for the timeout to trigger execution lastArgs: Parameters | undefined; ``` -Defined in: [debouncer.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L22) +Defined in: [debouncer.ts:22](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L22) The arguments from the most recent call to maybeExecute @@ -69,7 +69,7 @@ The arguments from the most recent call to maybeExecute maybeExecuteCount: number; ``` -Defined in: [debouncer.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L26) +Defined in: [debouncer.ts:26](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L26) Number of times maybeExecute has been called (for reduction calculations) @@ -81,6 +81,6 @@ Number of times maybeExecute has been called (for reduction calculations) status: "disabled" | "idle" | "pending"; ``` -Defined in: [debouncer.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/debouncer.ts#L30) +Defined in: [debouncer.ts:30](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/debouncer.ts#L30) Current execution status - 'idle' when not active, 'pending' when waiting for timeout diff --git a/docs/reference/interfaces/PacerEventMap.md b/docs/reference/interfaces/PacerEventMap.md index 3182e69c8..7f1d04349 100644 --- a/docs/reference/interfaces/PacerEventMap.md +++ b/docs/reference/interfaces/PacerEventMap.md @@ -5,7 +5,7 @@ title: PacerEventMap # Interface: PacerEventMap -Defined in: [event-client.ts:14](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L14) +Defined in: [event-client.ts:14](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L14) ## Properties @@ -15,7 +15,7 @@ Defined in: [event-client.ts:14](https://github.com/TanStack/pacer/blob/main/pac pacer:AsyncBatcher: AsyncBatcher; ``` -Defined in: [event-client.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L26) +Defined in: [event-client.ts:26](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L26) *** @@ -25,7 +25,7 @@ Defined in: [event-client.ts:26](https://github.com/TanStack/pacer/blob/main/pac pacer:AsyncDebouncer: AsyncDebouncer; ``` -Defined in: [event-client.ts:27](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L27) +Defined in: [event-client.ts:27](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L27) *** @@ -35,7 +35,7 @@ Defined in: [event-client.ts:27](https://github.com/TanStack/pacer/blob/main/pac pacer:AsyncQueuer: AsyncQueuer; ``` -Defined in: [event-client.ts:28](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L28) +Defined in: [event-client.ts:28](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L28) *** @@ -45,7 +45,7 @@ Defined in: [event-client.ts:28](https://github.com/TanStack/pacer/blob/main/pac pacer:AsyncRateLimiter: AsyncRateLimiter; ``` -Defined in: [event-client.ts:29](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L29) +Defined in: [event-client.ts:29](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L29) *** @@ -55,7 +55,7 @@ Defined in: [event-client.ts:29](https://github.com/TanStack/pacer/blob/main/pac pacer:AsyncRetryer: AsyncRetryer; ``` -Defined in: [event-client.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L30) +Defined in: [event-client.ts:30](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L30) *** @@ -65,7 +65,7 @@ Defined in: [event-client.ts:30](https://github.com/TanStack/pacer/blob/main/pac pacer:AsyncThrottler: AsyncThrottler; ``` -Defined in: [event-client.ts:31](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L31) +Defined in: [event-client.ts:31](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L31) *** @@ -75,7 +75,7 @@ Defined in: [event-client.ts:31](https://github.com/TanStack/pacer/blob/main/pac pacer:Batcher: Batcher; ``` -Defined in: [event-client.ts:32](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L32) +Defined in: [event-client.ts:32](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L32) *** @@ -85,7 +85,7 @@ Defined in: [event-client.ts:32](https://github.com/TanStack/pacer/blob/main/pac pacer:d-AsyncBatcher: AsyncBatcher; ``` -Defined in: [event-client.ts:15](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L15) +Defined in: [event-client.ts:15](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L15) *** @@ -95,7 +95,7 @@ Defined in: [event-client.ts:15](https://github.com/TanStack/pacer/blob/main/pac pacer:d-AsyncDebouncer: AsyncDebouncer; ``` -Defined in: [event-client.ts:16](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L16) +Defined in: [event-client.ts:16](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L16) *** @@ -105,7 +105,7 @@ Defined in: [event-client.ts:16](https://github.com/TanStack/pacer/blob/main/pac pacer:d-AsyncQueuer: AsyncQueuer; ``` -Defined in: [event-client.ts:17](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L17) +Defined in: [event-client.ts:17](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L17) *** @@ -115,7 +115,7 @@ Defined in: [event-client.ts:17](https://github.com/TanStack/pacer/blob/main/pac pacer:d-AsyncRateLimiter: AsyncRateLimiter; ``` -Defined in: [event-client.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L18) +Defined in: [event-client.ts:18](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L18) *** @@ -125,7 +125,7 @@ Defined in: [event-client.ts:18](https://github.com/TanStack/pacer/blob/main/pac pacer:d-AsyncRetryer: AsyncRetryer; ``` -Defined in: [event-client.ts:19](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L19) +Defined in: [event-client.ts:19](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L19) *** @@ -135,7 +135,7 @@ Defined in: [event-client.ts:19](https://github.com/TanStack/pacer/blob/main/pac pacer:d-AsyncThrottler: AsyncThrottler; ``` -Defined in: [event-client.ts:20](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L20) +Defined in: [event-client.ts:20](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L20) *** @@ -145,7 +145,7 @@ Defined in: [event-client.ts:20](https://github.com/TanStack/pacer/blob/main/pac pacer:d-Batcher: Batcher; ``` -Defined in: [event-client.ts:21](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L21) +Defined in: [event-client.ts:21](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L21) *** @@ -155,7 +155,7 @@ Defined in: [event-client.ts:21](https://github.com/TanStack/pacer/blob/main/pac pacer:d-Debouncer: Debouncer; ``` -Defined in: [event-client.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L22) +Defined in: [event-client.ts:22](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L22) *** @@ -165,7 +165,7 @@ Defined in: [event-client.ts:22](https://github.com/TanStack/pacer/blob/main/pac pacer:d-Queuer: Queuer; ``` -Defined in: [event-client.ts:23](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L23) +Defined in: [event-client.ts:23](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L23) *** @@ -175,7 +175,7 @@ Defined in: [event-client.ts:23](https://github.com/TanStack/pacer/blob/main/pac pacer:d-RateLimiter: RateLimiter; ``` -Defined in: [event-client.ts:24](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L24) +Defined in: [event-client.ts:24](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L24) *** @@ -185,7 +185,7 @@ Defined in: [event-client.ts:24](https://github.com/TanStack/pacer/blob/main/pac pacer:d-Throttler: Throttler; ``` -Defined in: [event-client.ts:25](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L25) +Defined in: [event-client.ts:25](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L25) *** @@ -195,7 +195,7 @@ Defined in: [event-client.ts:25](https://github.com/TanStack/pacer/blob/main/pac pacer:Debouncer: Debouncer; ``` -Defined in: [event-client.ts:33](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L33) +Defined in: [event-client.ts:33](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L33) *** @@ -205,7 +205,7 @@ Defined in: [event-client.ts:33](https://github.com/TanStack/pacer/blob/main/pac pacer:Queuer: Queuer; ``` -Defined in: [event-client.ts:34](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L34) +Defined in: [event-client.ts:34](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L34) *** @@ -215,7 +215,7 @@ Defined in: [event-client.ts:34](https://github.com/TanStack/pacer/blob/main/pac pacer:RateLimiter: RateLimiter; ``` -Defined in: [event-client.ts:35](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L35) +Defined in: [event-client.ts:35](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L35) *** @@ -225,4 +225,4 @@ Defined in: [event-client.ts:35](https://github.com/TanStack/pacer/blob/main/pac pacer:Throttler: Throttler; ``` -Defined in: [event-client.ts:36](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L36) +Defined in: [event-client.ts:36](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L36) diff --git a/docs/reference/interfaces/QueuerOptions.md b/docs/reference/interfaces/QueuerOptions.md index 6823799dd..b4eee6af6 100644 --- a/docs/reference/interfaces/QueuerOptions.md +++ b/docs/reference/interfaces/QueuerOptions.md @@ -5,7 +5,7 @@ title: QueuerOptions # Interface: QueuerOptions\ -Defined in: [queuer.ts:83](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L83) +Defined in: [queuer.ts:83](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L83) Options for configuring a Queuer instance. @@ -25,7 +25,7 @@ These options control queue behavior, item expiration, callbacks, and more. optional addItemsTo: QueuePosition; ``` -Defined in: [queuer.ts:88](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L88) +Defined in: [queuer.ts:88](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L88) Default position to add items to the queuer @@ -43,7 +43,7 @@ Default position to add items to the queuer optional expirationDuration: number; ``` -Defined in: [queuer.ts:93](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L93) +Defined in: [queuer.ts:93](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L93) Maximum time in milliseconds that an item can stay in the queue If not provided, items will never expire @@ -56,7 +56,7 @@ If not provided, items will never expire optional getIsExpired: (item, addedAt) => boolean; ``` -Defined in: [queuer.ts:98](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L98) +Defined in: [queuer.ts:98](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L98) Function to determine if an item has expired If provided, this overrides the expirationDuration behavior @@ -83,7 +83,7 @@ If provided, this overrides the expirationDuration behavior optional getItemsFrom: QueuePosition; ``` -Defined in: [queuer.ts:103](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L103) +Defined in: [queuer.ts:103](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L103) Default position to get items from during processing @@ -101,7 +101,7 @@ Default position to get items from during processing optional getPriority: (item) => number; ``` -Defined in: [queuer.ts:108](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L108) +Defined in: [queuer.ts:108](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L108) Function to determine priority of items in the queuer Higher priority items will be processed first @@ -124,7 +124,7 @@ Higher priority items will be processed first optional initialItems: TValue[]; ``` -Defined in: [queuer.ts:112](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L112) +Defined in: [queuer.ts:112](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L112) Initial items to populate the queuer with @@ -136,7 +136,7 @@ Initial items to populate the queuer with optional initialState: Partial>; ``` -Defined in: [queuer.ts:116](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L116) +Defined in: [queuer.ts:116](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L116) Initial state for the queuer @@ -148,7 +148,7 @@ Initial state for the queuer optional key: string; ``` -Defined in: [queuer.ts:121](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L121) +Defined in: [queuer.ts:121](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L121) Optional key to identify this queuer instance. If provided, the queuer will be identified by this key in the devtools and PacerProvider if applicable. @@ -161,7 +161,7 @@ If provided, the queuer will be identified by this key in the devtools and Pacer optional maxSize: number; ``` -Defined in: [queuer.ts:125](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L125) +Defined in: [queuer.ts:125](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L125) Maximum number of items allowed in the queuer @@ -173,7 +173,7 @@ Maximum number of items allowed in the queuer optional onExecute: (item, queuer) => void; ``` -Defined in: [queuer.ts:129](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L129) +Defined in: [queuer.ts:129](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L129) Callback fired whenever an item is removed from the queuer @@ -199,7 +199,7 @@ Callback fired whenever an item is removed from the queuer optional onExpire: (item, queuer) => void; ``` -Defined in: [queuer.ts:133](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L133) +Defined in: [queuer.ts:133](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L133) Callback fired whenever an item expires in the queuer @@ -225,7 +225,7 @@ Callback fired whenever an item expires in the queuer optional onItemsChange: (queuer) => void; ``` -Defined in: [queuer.ts:137](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L137) +Defined in: [queuer.ts:137](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L137) Callback fired whenever an item is added or removed from the queuer @@ -247,7 +247,7 @@ Callback fired whenever an item is added or removed from the queuer optional onReject: (item, queuer) => void; ``` -Defined in: [queuer.ts:141](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L141) +Defined in: [queuer.ts:141](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L141) Callback fired whenever an item is rejected from being added to the queuer @@ -273,7 +273,7 @@ Callback fired whenever an item is rejected from being added to the queuer optional started: boolean; ``` -Defined in: [queuer.ts:145](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L145) +Defined in: [queuer.ts:145](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L145) Whether the queuer should start processing tasks immediately @@ -285,7 +285,7 @@ Whether the queuer should start processing tasks immediately optional wait: number | (queuer) => number; ``` -Defined in: [queuer.ts:151](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L151) +Defined in: [queuer.ts:151](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L151) Time in milliseconds to wait between processing items. Can be a number or a function that returns a number. diff --git a/docs/reference/interfaces/QueuerState.md b/docs/reference/interfaces/QueuerState.md index f6fee041b..4a8ecc9c9 100644 --- a/docs/reference/interfaces/QueuerState.md +++ b/docs/reference/interfaces/QueuerState.md @@ -5,7 +5,7 @@ title: QueuerState # Interface: QueuerState\ -Defined in: [queuer.ts:5](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L5) +Defined in: [queuer.ts:5](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L5) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [queuer.ts:5](https://github.com/TanStack/pacer/blob/main/packages/p addItemCount: number; ``` -Defined in: [queuer.ts:9](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L9) +Defined in: [queuer.ts:9](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L9) Number of times addItem has been called (for reduction calculations) @@ -33,7 +33,7 @@ Number of times addItem has been called (for reduction calculations) executionCount: number; ``` -Defined in: [queuer.ts:13](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L13) +Defined in: [queuer.ts:13](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L13) Number of items that have been processed by the queuer @@ -45,7 +45,7 @@ Number of items that have been processed by the queuer expirationCount: number; ``` -Defined in: [queuer.ts:17](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L17) +Defined in: [queuer.ts:17](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L17) Number of items that have been removed from the queue due to expiration @@ -57,7 +57,7 @@ Number of items that have been removed from the queue due to expiration isEmpty: boolean; ``` -Defined in: [queuer.ts:21](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L21) +Defined in: [queuer.ts:21](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L21) Whether the queuer has no items to process (items array is empty) @@ -69,7 +69,7 @@ Whether the queuer has no items to process (items array is empty) isFull: boolean; ``` -Defined in: [queuer.ts:25](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L25) +Defined in: [queuer.ts:25](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L25) Whether the queuer has reached its maximum capacity @@ -81,7 +81,7 @@ Whether the queuer has reached its maximum capacity isIdle: boolean; ``` -Defined in: [queuer.ts:29](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L29) +Defined in: [queuer.ts:29](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L29) Whether the queuer is not currently processing any items @@ -93,7 +93,7 @@ Whether the queuer is not currently processing any items isRunning: boolean; ``` -Defined in: [queuer.ts:33](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L33) +Defined in: [queuer.ts:33](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L33) Whether the queuer is active and will process items automatically @@ -105,7 +105,7 @@ Whether the queuer is active and will process items automatically items: TValue[]; ``` -Defined in: [queuer.ts:37](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L37) +Defined in: [queuer.ts:37](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L37) Array of items currently waiting to be processed @@ -117,7 +117,7 @@ Array of items currently waiting to be processed itemTimestamps: number[]; ``` -Defined in: [queuer.ts:41](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L41) +Defined in: [queuer.ts:41](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L41) Timestamps when items were added to the queue for expiration tracking @@ -129,7 +129,7 @@ Timestamps when items were added to the queue for expiration tracking pendingTick: boolean; ``` -Defined in: [queuer.ts:45](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L45) +Defined in: [queuer.ts:45](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L45) Whether the queuer has a pending timeout for processing the next item @@ -141,7 +141,7 @@ Whether the queuer has a pending timeout for processing the next item rejectionCount: number; ``` -Defined in: [queuer.ts:49](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L49) +Defined in: [queuer.ts:49](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L49) Number of items that have been rejected from being added to the queue @@ -153,7 +153,7 @@ Number of items that have been rejected from being added to the queue size: number; ``` -Defined in: [queuer.ts:53](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L53) +Defined in: [queuer.ts:53](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L53) Number of items currently in the queue @@ -165,6 +165,6 @@ Number of items currently in the queue status: "idle" | "running" | "stopped"; ``` -Defined in: [queuer.ts:57](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L57) +Defined in: [queuer.ts:57](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L57) Current processing status - 'idle' when not processing, 'running' when active, 'stopped' when paused diff --git a/docs/reference/interfaces/RateLimiterOptions.md b/docs/reference/interfaces/RateLimiterOptions.md index cd652d60c..34a477c73 100644 --- a/docs/reference/interfaces/RateLimiterOptions.md +++ b/docs/reference/interfaces/RateLimiterOptions.md @@ -5,7 +5,7 @@ title: RateLimiterOptions # Interface: RateLimiterOptions\ -Defined in: [rate-limiter.ts:47](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L47) +Defined in: [rate-limiter.ts:47](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L47) Options for configuring a rate-limited function @@ -23,7 +23,7 @@ Options for configuring a rate-limited function optional enabled: boolean | (rateLimiter) => boolean; ``` -Defined in: [rate-limiter.ts:52](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L52) +Defined in: [rate-limiter.ts:52](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L52) Whether the rate limiter is enabled. When disabled, maybeExecute will not trigger any executions. Defaults to true. @@ -36,7 +36,7 @@ Defaults to true. optional initialState: Partial; ``` -Defined in: [rate-limiter.ts:56](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L56) +Defined in: [rate-limiter.ts:56](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L56) Initial state for the rate limiter @@ -48,7 +48,7 @@ Initial state for the rate limiter optional key: string; ``` -Defined in: [rate-limiter.ts:61](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L61) +Defined in: [rate-limiter.ts:61](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L61) Optional key to identify this rate limiter instance. If provided, the rate limiter will be identified by this key in the devtools and PacerProvider if applicable. @@ -61,7 +61,7 @@ If provided, the rate limiter will be identified by this key in the devtools and limit: number | (rateLimiter) => number; ``` -Defined in: [rate-limiter.ts:66](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L66) +Defined in: [rate-limiter.ts:66](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L66) Maximum number of executions allowed within the time window. Can be a number or a callback function that receives the rate limiter instance and returns a number. @@ -74,7 +74,7 @@ Can be a number or a callback function that receives the rate limiter instance a optional onExecute: (args, rateLimiter) => void; ``` -Defined in: [rate-limiter.ts:70](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L70) +Defined in: [rate-limiter.ts:70](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L70) Callback function that is called after the function is executed @@ -100,7 +100,7 @@ Callback function that is called after the function is executed optional onReject: (rateLimiter) => void; ``` -Defined in: [rate-limiter.ts:74](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L74) +Defined in: [rate-limiter.ts:74](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L74) Optional callback function that is called when an execution is rejected due to rate limiting @@ -122,7 +122,7 @@ Optional callback function that is called when an execution is rejected due to r window: number | (rateLimiter) => number; ``` -Defined in: [rate-limiter.ts:79](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L79) +Defined in: [rate-limiter.ts:79](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L79) Time window in milliseconds within which the limit applies. Can be a number or a callback function that receives the rate limiter instance and returns a number. @@ -135,7 +135,7 @@ Can be a number or a callback function that receives the rate limiter instance a optional windowType: "fixed" | "sliding"; ``` -Defined in: [rate-limiter.ts:86](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L86) +Defined in: [rate-limiter.ts:86](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L86) Type of window to use for rate limiting - 'fixed': Uses a fixed window that resets after the window period diff --git a/docs/reference/interfaces/RateLimiterState.md b/docs/reference/interfaces/RateLimiterState.md index ae3aa03ff..0dd17fa29 100644 --- a/docs/reference/interfaces/RateLimiterState.md +++ b/docs/reference/interfaces/RateLimiterState.md @@ -5,7 +5,7 @@ title: RateLimiterState # Interface: RateLimiterState -Defined in: [rate-limiter.ts:6](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L6) +Defined in: [rate-limiter.ts:6](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L6) ## Properties @@ -15,7 +15,7 @@ Defined in: [rate-limiter.ts:6](https://github.com/TanStack/pacer/blob/main/pack executionCount: number; ``` -Defined in: [rate-limiter.ts:10](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L10) +Defined in: [rate-limiter.ts:10](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L10) Number of function executions that have been completed @@ -27,7 +27,7 @@ Number of function executions that have been completed executionTimes: number[]; ``` -Defined in: [rate-limiter.ts:14](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L14) +Defined in: [rate-limiter.ts:14](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L14) Array of timestamps when executions occurred for rate limiting calculations @@ -39,7 +39,7 @@ Array of timestamps when executions occurred for rate limiting calculations isExceeded: boolean; ``` -Defined in: [rate-limiter.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L18) +Defined in: [rate-limiter.ts:18](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L18) Whether the rate limiter has exceeded the limit @@ -51,7 +51,7 @@ Whether the rate limiter has exceeded the limit maybeExecuteCount: number; ``` -Defined in: [rate-limiter.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L22) +Defined in: [rate-limiter.ts:22](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L22) Number of times maybeExecute has been called (for reduction calculations) @@ -63,7 +63,7 @@ Number of times maybeExecute has been called (for reduction calculations) rejectionCount: number; ``` -Defined in: [rate-limiter.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L26) +Defined in: [rate-limiter.ts:26](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L26) Number of function executions that have been rejected due to rate limiting @@ -75,6 +75,6 @@ Number of function executions that have been rejected due to rate limiting status: "disabled" | "idle" | "exceeded"; ``` -Defined in: [rate-limiter.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L30) +Defined in: [rate-limiter.ts:30](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/rate-limiter.ts#L30) Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded diff --git a/docs/reference/interfaces/ThrottlerOptions.md b/docs/reference/interfaces/ThrottlerOptions.md index 0181d71c0..564120b38 100644 --- a/docs/reference/interfaces/ThrottlerOptions.md +++ b/docs/reference/interfaces/ThrottlerOptions.md @@ -5,7 +5,7 @@ title: ThrottlerOptions # Interface: ThrottlerOptions\ -Defined in: [throttler.ts:54](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L54) +Defined in: [throttler.ts:54](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L54) Options for configuring a throttled function @@ -23,7 +23,7 @@ Options for configuring a throttled function optional enabled: boolean | (throttler) => boolean; ``` -Defined in: [throttler.ts:60](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L60) +Defined in: [throttler.ts:60](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L60) Whether the throttler is enabled. When disabled, maybeExecute will not trigger any executions. Can be a boolean or a function that returns a boolean. @@ -37,7 +37,7 @@ Defaults to true. optional initialState: Partial>; ``` -Defined in: [throttler.ts:64](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L64) +Defined in: [throttler.ts:64](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L64) Initial state for the throttler @@ -49,7 +49,7 @@ Initial state for the throttler optional key: string; ``` -Defined in: [throttler.ts:69](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L69) +Defined in: [throttler.ts:69](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L69) A key to identify the throttler. If provided, the throttler will be identified by this key in the devtools and PacerProvider if applicable. @@ -62,7 +62,7 @@ If provided, the throttler will be identified by this key in the devtools and Pa optional leading: boolean; ``` -Defined in: [throttler.ts:74](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L74) +Defined in: [throttler.ts:74](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L74) Whether to execute on the leading edge of the timeout. Defaults to true. @@ -75,7 +75,7 @@ Defaults to true. optional onExecute: (args, throttler) => void; ``` -Defined in: [throttler.ts:78](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L78) +Defined in: [throttler.ts:78](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L78) Callback function that is called after the function is executed @@ -101,7 +101,7 @@ Callback function that is called after the function is executed optional trailing: boolean; ``` -Defined in: [throttler.ts:83](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L83) +Defined in: [throttler.ts:83](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L83) Whether to execute on the trailing edge of the timeout. Defaults to true. @@ -114,7 +114,7 @@ Defaults to true. wait: number | (throttler) => number; ``` -Defined in: [throttler.ts:89](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L89) +Defined in: [throttler.ts:89](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L89) Time window in milliseconds during which the function can only be executed once. Can be a number or a function that returns a number. diff --git a/docs/reference/interfaces/ThrottlerState.md b/docs/reference/interfaces/ThrottlerState.md index 3ffbd9e4c..6440ae778 100644 --- a/docs/reference/interfaces/ThrottlerState.md +++ b/docs/reference/interfaces/ThrottlerState.md @@ -5,7 +5,7 @@ title: ThrottlerState # Interface: ThrottlerState\ -Defined in: [throttler.ts:6](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L6) +Defined in: [throttler.ts:6](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L6) ## Type Parameters @@ -21,7 +21,7 @@ Defined in: [throttler.ts:6](https://github.com/TanStack/pacer/blob/main/package executionCount: number; ``` -Defined in: [throttler.ts:10](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L10) +Defined in: [throttler.ts:10](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L10) Number of function executions that have been completed @@ -33,7 +33,7 @@ Number of function executions that have been completed isPending: boolean; ``` -Defined in: [throttler.ts:14](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L14) +Defined in: [throttler.ts:14](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L14) Whether the throttler is waiting for the timeout to trigger execution @@ -45,7 +45,7 @@ Whether the throttler is waiting for the timeout to trigger execution lastArgs: Parameters | undefined; ``` -Defined in: [throttler.ts:18](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L18) +Defined in: [throttler.ts:18](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L18) The arguments from the most recent call to maybeExecute @@ -57,7 +57,7 @@ The arguments from the most recent call to maybeExecute lastExecutionTime: number; ``` -Defined in: [throttler.ts:22](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L22) +Defined in: [throttler.ts:22](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L22) Timestamp of the last function execution in milliseconds @@ -69,7 +69,7 @@ Timestamp of the last function execution in milliseconds maybeExecuteCount: number; ``` -Defined in: [throttler.ts:26](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L26) +Defined in: [throttler.ts:26](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L26) Number of times maybeExecute has been called (for reduction calculations) @@ -81,7 +81,7 @@ Number of times maybeExecute has been called (for reduction calculations) nextExecutionTime: number | undefined; ``` -Defined in: [throttler.ts:30](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L30) +Defined in: [throttler.ts:30](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L30) Timestamp when the next execution can occur in milliseconds @@ -93,6 +93,6 @@ Timestamp when the next execution can occur in milliseconds status: "disabled" | "idle" | "pending"; ``` -Defined in: [throttler.ts:34](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/throttler.ts#L34) +Defined in: [throttler.ts:34](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/throttler.ts#L34) Current execution status - 'idle' when not active, 'pending' when waiting for timeout diff --git a/docs/reference/type-aliases/AnyAsyncFunction.md b/docs/reference/type-aliases/AnyAsyncFunction.md index 7153af274..f131ae86a 100644 --- a/docs/reference/type-aliases/AnyAsyncFunction.md +++ b/docs/reference/type-aliases/AnyAsyncFunction.md @@ -9,7 +9,7 @@ title: AnyAsyncFunction type AnyAsyncFunction = (...args) => Promise; ``` -Defined in: [types.ts:9](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/types.ts#L9) +Defined in: [types.ts:9](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/types.ts#L9) Represents an asynchronous function that can be called with any arguments and returns a promise. diff --git a/docs/reference/type-aliases/AnyFunction.md b/docs/reference/type-aliases/AnyFunction.md index 8b450bc85..79d02d34e 100644 --- a/docs/reference/type-aliases/AnyFunction.md +++ b/docs/reference/type-aliases/AnyFunction.md @@ -9,7 +9,7 @@ title: AnyFunction type AnyFunction = (...args) => any; ``` -Defined in: [types.ts:4](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/types.ts#L4) +Defined in: [types.ts:4](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/types.ts#L4) Represents a function that can be called with any arguments and returns any value. diff --git a/docs/reference/type-aliases/OptionalKeys.md b/docs/reference/type-aliases/OptionalKeys.md index aaa7cf5cb..a1b7a34c6 100644 --- a/docs/reference/type-aliases/OptionalKeys.md +++ b/docs/reference/type-aliases/OptionalKeys.md @@ -9,7 +9,7 @@ title: OptionalKeys type OptionalKeys = Omit & Partial>; ``` -Defined in: [types.ts:11](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/types.ts#L11) +Defined in: [types.ts:11](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/types.ts#L11) ## Type Parameters diff --git a/docs/reference/type-aliases/PacerEventName.md b/docs/reference/type-aliases/PacerEventName.md index 18fbeafb1..98fcfacb5 100644 --- a/docs/reference/type-aliases/PacerEventName.md +++ b/docs/reference/type-aliases/PacerEventName.md @@ -9,4 +9,4 @@ title: PacerEventName type PacerEventName = keyof PacerEventMap extends `pacer:${infer T}` ? T : never; ``` -Defined in: [event-client.ts:39](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L39) +Defined in: [event-client.ts:39](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L39) diff --git a/docs/reference/type-aliases/QueuePosition.md b/docs/reference/type-aliases/QueuePosition.md index 9fa8f2e31..fe3fe085d 100644 --- a/docs/reference/type-aliases/QueuePosition.md +++ b/docs/reference/type-aliases/QueuePosition.md @@ -9,7 +9,7 @@ title: QueuePosition type QueuePosition = "front" | "back"; ``` -Defined in: [queuer.ts:193](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/queuer.ts#L193) +Defined in: [queuer.ts:193](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/queuer.ts#L193) Position type for addItem and getNextItem operations. diff --git a/docs/reference/variables/pacerEventClient.md b/docs/reference/variables/pacerEventClient.md index 6f98a5d65..e0886c06e 100644 --- a/docs/reference/variables/pacerEventClient.md +++ b/docs/reference/variables/pacerEventClient.md @@ -9,4 +9,4 @@ title: pacerEventClient const pacerEventClient: PacerEventClient; ``` -Defined in: [event-client.ts:68](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/event-client.ts#L68) +Defined in: [event-client.ts:68](https://github.com/ghostd/pacer/blob/main/packages/pacer/src/event-client.ts#L68) diff --git a/packages/pacer/src/async-debouncer.ts b/packages/pacer/src/async-debouncer.ts index 49d66c358..099d3552b 100644 --- a/packages/pacer/src/async-debouncer.ts +++ b/packages/pacer/src/async-debouncer.ts @@ -29,7 +29,7 @@ export interface AsyncDebouncerState { /** * The result from the most recent successful function execution */ - lastResult: ReturnType | undefined + lastResult: Awaited> | undefined /** * Number of times maybeExecute has been called (for reduction calculations) */ @@ -111,7 +111,7 @@ export interface AsyncDebouncerOptions { * Optional callback to call when the debounced function is executed */ onSuccess?: ( - result: ReturnType, + result: Awaited>, args: Parameters, debouncer: AsyncDebouncer, ) => void @@ -224,7 +224,7 @@ export class AsyncDebouncer { asyncRetryers = new Map>() #timeoutId: NodeJS.Timeout | null = null #resolvePreviousPromise: - | ((value?: ReturnType | undefined) => void) + | ((value?: Awaited> | undefined) => void) | null = null constructor( @@ -313,7 +313,7 @@ export class AsyncDebouncer { */ maybeExecute = async ( ...args: Parameters - ): Promise | undefined> => { + ): Promise> | undefined> => { if (!this.#getEnabled()) return undefined this.#cancelPendingExecution() this.#setState({ @@ -333,7 +333,7 @@ export class AsyncDebouncer { this.#setState({ isPending: true }) } - return new Promise((resolve, reject) => { + return new Promise> | undefined>((resolve, reject) => { this.#resolvePreviousPromise = resolve // this.#rejectPreviousPromise = reject this.#timeoutId = setTimeout(async () => { @@ -356,7 +356,7 @@ export class AsyncDebouncer { #execute = async ( ...args: Parameters - ): Promise | undefined> => { + ): Promise> | undefined> => { if (!this.#getEnabled()) return undefined const currentMaybeExecuteCount = this.store.state.maybeExecuteCount + 1 @@ -372,7 +372,7 @@ export class AsyncDebouncer { lastResult: result, successCount: this.store.state.successCount + 1, }) - this.options.onSuccess?.(result as ReturnType, args, this) + this.options.onSuccess?.(result as Awaited>, args, this) } catch (error) { this.#setState({ errorCount: this.store.state.errorCount + 1, @@ -397,7 +397,7 @@ export class AsyncDebouncer { /** * Processes the current pending execution immediately */ - flush = async (): Promise | undefined> => { + flush = async (): Promise> | undefined> => { if (this.store.state.isPending && this.store.state.lastArgs) { const { lastArgs } = this.store.state this.#cancelPendingExecution() diff --git a/packages/pacer/src/async-rate-limiter.ts b/packages/pacer/src/async-rate-limiter.ts index 03a25d23a..6fad6f74d 100644 --- a/packages/pacer/src/async-rate-limiter.ts +++ b/packages/pacer/src/async-rate-limiter.ts @@ -25,7 +25,7 @@ export interface AsyncRateLimiterState { /** * The result from the most recent successful function execution */ - lastResult: ReturnType | undefined + lastResult: Awaited> | undefined /** * Number of function executions that have been rejected due to rate limiting */ @@ -118,7 +118,7 @@ export interface AsyncRateLimiterOptions { * Optional function to call when the rate-limited function is executed */ onSuccess?: ( - result: ReturnType, + result: Awaited>, args: Parameters, rateLimiter: AsyncRateLimiter, ) => void @@ -353,7 +353,7 @@ export class AsyncRateLimiter { */ maybeExecute = async ( ...args: Parameters - ): Promise | undefined> => { + ): Promise> | undefined> => { this.#setState({ maybeExecuteCount: this.store.state.maybeExecuteCount + 1, }) @@ -376,7 +376,7 @@ export class AsyncRateLimiter { #execute = async ( ...args: Parameters - ): Promise | undefined> => { + ): Promise> | undefined> => { if (!this.#getEnabled()) return const currentMaybeExecute = this.store.state.maybeExecuteCount @@ -400,7 +400,7 @@ export class AsyncRateLimiter { successCount: this.store.state.successCount + 1, lastResult: result, }) - this.options.onSuccess?.(result as ReturnType, args, this) + this.options.onSuccess?.(result as Awaited>, args, this) } catch (error) { this.#setState({ errorCount: this.store.state.errorCount + 1, diff --git a/packages/pacer/src/async-throttler.ts b/packages/pacer/src/async-throttler.ts index 5338c2990..d75a63711 100644 --- a/packages/pacer/src/async-throttler.ts +++ b/packages/pacer/src/async-throttler.ts @@ -29,7 +29,7 @@ export interface AsyncThrottlerState { /** * The result from the most recent successful function execution */ - lastResult: ReturnType | undefined + lastResult: Awaited> | undefined /** * Number of times maybeExecute has been called (for reduction calculations) */ @@ -236,7 +236,7 @@ export class AsyncThrottler { asyncRetryers = new Map>() #timeoutId: NodeJS.Timeout | null = null #resolvePreviousPromise: - | ((value?: ReturnType | undefined) => void) + | ((value?: Awaited> | undefined) => void) | null = null constructor( @@ -333,7 +333,7 @@ export class AsyncThrottler { */ maybeExecute = async ( ...args: Parameters - ): Promise | undefined> => { + ): Promise> | undefined> => { if (!this.#getEnabled()) return undefined this.#resolvePreviousPromiseInternal() @@ -376,34 +376,36 @@ export class AsyncThrottler { }) // Set up new trailing execution - return new Promise((resolve, reject) => { - this.#resolvePreviousPromise = resolve - - const newTimeSinceLastExecution = this.store.state.lastExecutionTime - ? now - this.store.state.lastExecutionTime - : 0 - const timeoutDuration = Math.max(0, wait - newTimeSinceLastExecution) - - this.#timeoutId = setTimeout(async () => { - this.#clearTimeout() - if (this.store.state.lastArgs !== undefined) { - try { - await this.#execute(...this.store.state.lastArgs) // Trailing EXECUTE! - } catch (error) { - reject(error) + return new Promise> | undefined>( + (resolve, reject) => { + this.#resolvePreviousPromise = resolve + + const newTimeSinceLastExecution = this.store.state.lastExecutionTime + ? now - this.store.state.lastExecutionTime + : 0 + const timeoutDuration = Math.max(0, wait - newTimeSinceLastExecution) + + this.#timeoutId = setTimeout(async () => { + this.#clearTimeout() + if (this.store.state.lastArgs !== undefined) { + try { + await this.#execute(...this.store.state.lastArgs) // Trailing EXECUTE! + } catch (error) { + reject(error) + } } - } - this.#resolvePreviousPromise = null - resolve(this.store.state.lastResult) - }, timeoutDuration) - }) + this.#resolvePreviousPromise = null + resolve(this.store.state.lastResult) + }, timeoutDuration) + }, + ) } return this.store.state.lastResult } #execute = async ( ...args: Parameters - ): Promise | undefined> => { + ): Promise> | undefined> => { if (!this.#getEnabled()) return undefined const currentMaybeExecute = this.store.state.maybeExecuteCount @@ -420,7 +422,7 @@ export class AsyncThrottler { lastResult: result, successCount: this.store.state.successCount + 1, }) - this.options.onSuccess?.(result as ReturnType, args, this) + this.options.onSuccess?.(result as Awaited>, args, this) } catch (error) { this.#setState({ errorCount: this.store.state.errorCount + 1, @@ -455,7 +457,7 @@ export class AsyncThrottler { /** * Processes the current pending execution immediately */ - flush = async (): Promise | undefined> => { + flush = async (): Promise> | undefined> => { if (this.store.state.isPending && this.store.state.lastArgs) { // Store the pending promise resolver before clearing timeout const resolvePromise = this.#resolvePreviousPromise diff --git a/packages/preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts b/packages/preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts index 8234ee077..214299aab 100644 --- a/packages/preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts +++ b/packages/preact-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts @@ -44,11 +44,11 @@ import type { AnyAsyncFunction } from '@tanstack/pacer/types' export function useAsyncDebouncedCallback( fn: TFn, options: PreactAsyncDebouncerOptions, -): (...args: Parameters) => Promise> { +): (...args: Parameters) => Promise>> { const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute return useCallback( (...args: Parameters) => - asyncDebouncedFn(...args) as Promise>, + asyncDebouncedFn(...args) as Promise>>, [asyncDebouncedFn], ) } diff --git a/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts b/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts index 052d0d5f7..c92e2368e 100644 --- a/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +++ b/packages/preact-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts @@ -59,11 +59,11 @@ import type { PreactAsyncRateLimiterOptions } from './useAsyncRateLimiter' export function useAsyncRateLimitedCallback( fn: TFn, options: PreactAsyncRateLimiterOptions, -): (...args: Parameters) => Promise> { +): (...args: Parameters) => Promise>> { const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute return useCallback( (...args: Parameters) => - asyncRateLimitedFn(...args) as Promise>, + asyncRateLimitedFn(...args) as Promise>>, [asyncRateLimitedFn], ) } diff --git a/packages/preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts b/packages/preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts index 896d17793..97fd8e675 100644 --- a/packages/preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts +++ b/packages/preact-pacer/src/async-throttler/useAsyncThrottledCallback.ts @@ -42,11 +42,11 @@ import type { AnyAsyncFunction } from '@tanstack/pacer/types' export function useAsyncThrottledCallback( fn: TFn, options: PreactAsyncThrottlerOptions, -): (...args: Parameters) => Promise> { +): (...args: Parameters) => Promise>> { const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute return useCallback( (...args: Parameters) => - asyncThrottledFn(...args) as Promise>, + asyncThrottledFn(...args) as Promise>>, [asyncThrottledFn], ) } diff --git a/packages/react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts b/packages/react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts index d919357a7..52341fd29 100644 --- a/packages/react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts +++ b/packages/react-pacer/src/async-debouncer/useAsyncDebouncedCallback.ts @@ -44,10 +44,10 @@ import type { AnyAsyncFunction } from '@tanstack/pacer/types' export function useAsyncDebouncedCallback( fn: TFn, options: ReactAsyncDebouncerOptions, -): (...args: Parameters) => Promise> { +): (...args: Parameters) => Promise>> { const asyncDebouncedFn = useAsyncDebouncer(fn, options).maybeExecute return useCallback( - (...args) => asyncDebouncedFn(...args) as Promise>, + (...args) => asyncDebouncedFn(...args) as Promise>>, [asyncDebouncedFn], ) } diff --git a/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts b/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts index 49c8d794f..3ae9df7ef 100644 --- a/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts +++ b/packages/react-pacer/src/async-rate-limiter/useAsyncRateLimitedCallback.ts @@ -59,10 +59,11 @@ import type { ReactAsyncRateLimiterOptions } from './useAsyncRateLimiter' export function useAsyncRateLimitedCallback( fn: TFn, options: ReactAsyncRateLimiterOptions, -): (...args: Parameters) => Promise> { +): (...args: Parameters) => Promise>> { const asyncRateLimitedFn = useAsyncRateLimiter(fn, options).maybeExecute return useCallback( - (...args) => asyncRateLimitedFn(...args) as Promise>, + (...args) => + asyncRateLimitedFn(...args) as Promise>>, [asyncRateLimitedFn], ) } diff --git a/packages/react-pacer/src/async-throttler/useAsyncThrottledCallback.ts b/packages/react-pacer/src/async-throttler/useAsyncThrottledCallback.ts index d1a8bdd70..8244cf9a1 100644 --- a/packages/react-pacer/src/async-throttler/useAsyncThrottledCallback.ts +++ b/packages/react-pacer/src/async-throttler/useAsyncThrottledCallback.ts @@ -42,10 +42,10 @@ import type { AnyAsyncFunction } from '@tanstack/pacer/types' export function useAsyncThrottledCallback( fn: TFn, options: ReactAsyncThrottlerOptions, -): (...args: Parameters) => Promise> { +): (...args: Parameters) => Promise>> { const asyncThrottledFn = useAsyncThrottler(fn, options).maybeExecute return useCallback( - (...args) => asyncThrottledFn(...args) as Promise>, + (...args) => asyncThrottledFn(...args) as Promise>>, [asyncThrottledFn], ) }