Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions .changeset/tiny-jobs-behave.md
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectAsyncBatchedCallback
function injectAsyncBatchedCallback<TValue>(fn, options): (item) => Promise<void>;
```

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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectAsyncBatcher<TValue, TSelected>(
selector): AngularAsyncBatcher<TValue, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectAsyncDebouncedCallback
function injectAsyncDebouncedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectAsyncDebouncer<TFn, TSelected>(
selector): AngularAsyncDebouncer<TFn, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectAsyncQueuedSignal<TValue, TSelected>(
selector): AsyncQueuedSignal<TValue, TSelected>;
```

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectAsyncQueuer<TValue, TSelected>(
selector): AngularAsyncQueuer<TValue, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectAsyncRateLimitedCallback
function injectAsyncRateLimitedCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectAsyncRateLimiter<TFn, TSelected>(
selector): AngularAsyncRateLimiter<TFn, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectAsyncThrottledCallback
function injectAsyncThrottledCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | 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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectAsyncThrottler<TFn, TSelected>(
selector): AngularAsyncThrottler<TFn, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectBatchedCallback
function injectBatchedCallback<TValue>(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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectBatcher<TValue, TSelected>(
selector): AngularBatcher<TValue, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectDebouncedCallback
function injectDebouncedCallback<TFn>(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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectDebouncedSignal<TValue, TSelected>(
selector?): DebouncedSignal<TValue, TSelected>;
```

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function injectDebouncedValue<TValue, TSelected>(
selector?): DebouncedSignal<TValue, TSelected>;
```

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
Expand Down Expand Up @@ -119,7 +119,7 @@ function injectDebouncedValue<TValue, TSelected>(
selector?): DebouncedSignal<TValue, TSelected>;
```

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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectDebouncer<TFn, TSelected>(
selector): AngularDebouncer<TFn, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectQueuedSignal<TValue, TSelected>(
selector): QueuedSignal<TValue, TSelected>;
```

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function injectQueuedValue<TValue, TSelected>(
selector?): QueuedSignal<TValue, TSelected>;
```

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.
Expand Down Expand Up @@ -78,7 +78,7 @@ function injectQueuedValue<TValue, TSelected>(
selector?): QueuedSignal<TValue, TSelected>;
```

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectQueuer.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectQueuer<TValue, TSelected>(
selector): AngularQueuer<TValue, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectRateLimitedCallback
function injectRateLimitedCallback<TFn>(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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectRateLimitedSignal<TValue, TSelected>(
selector?): RateLimitedSignal<TValue, TSelected>;
```

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function injectRateLimitedValue<TValue, TSelected>(
selector?): RateLimitedSignal<TValue, TSelected>;
```

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
Expand Down Expand Up @@ -93,7 +93,7 @@ function injectRateLimitedValue<TValue, TSelected>(
selector?): RateLimitedSignal<TValue, TSelected>;
```

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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectRateLimiter<TFn, TSelected>(
selector): AngularRateLimiter<TFn, TSelected>;
```

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ title: injectThrottledCallback
function injectThrottledCallback<TFn>(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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectThrottledSignal<TValue, TSelected>(
selector?): ThrottledSignal<TValue, TSelected>;
```

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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ function injectThrottledValue<TValue, TSelected>(
selector?): ThrottledSignal<TValue, TSelected>;
```

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
Expand Down Expand Up @@ -118,7 +118,7 @@ function injectThrottledValue<TValue, TSelected>(
selector?): ThrottledSignal<TValue, TSelected>;
```

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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ function injectThrottler<TFn, TSelected>(
selector): AngularThrottler<TFn, TSelected>;
```

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.

Expand Down
Loading