Skip to content

Fix angular input + API consistency #161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
benjavicente wants to merge 10 commits into
base: main
Choose a base branch
from
Open

Fix angular input + API consistency #161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8450101
test: add angular required input reproduction
benjavicente Feb 22, 2026
e92f072
fix: call value inside linked signal
benjavicente Feb 22, 2026
3e7f8aa
fix: align angular queued value api
benjavicente Feb 22, 2026
d0fbeb6
fix: linting with new angular ts config
benjavicente Feb 22, 2026
8741177
docs: update angular generated docs
benjavicente Feb 22, 2026
684b39b
chore: add changeset
benjavicente Feb 22, 2026
881aad8
chore: use local type definition
benjavicente Jun 6, 2026
ed63e12
chore: bump angular deps
benjavicente Jun 6, 2026
cf80673
fix: address angular review feedback
benjavicente Jul 14, 2026
568e6a5
docs: correct angular queuer property name
benjavicente Jul 14, 2026
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
5 changes: 5 additions & 0 deletions .changeset/big-jobs-call.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@tanstack/angular-pacer': minor
---

injectQueuedValue returns queued value instead of array
5 changes: 3 additions & 2 deletions docs/framework/angular/reference/functions/injectAsyncBatchedCallback.md
View file
Open in desktop
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: [async-batcher/injectAsyncBatchedCallback.ts:42](https://github.com/TanStack/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 Expand Up @@ -43,7 +43,8 @@ Consider using the `injectAsyncBatcher` function instead.

### options

`AsyncBatcherOptions`\<`TValue`\>
[`AngularAsyncBatcherOptions`](../interfaces/AngularAsyncBatcherOptions.md)\<`TValue`, \{
\}\>

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectAsyncBatcher.md
View file
Open in desktop
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: [async-batcher/injectAsyncBatcher.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-batcher/injectAsyncBatcher.ts#L96)

An Angular function that creates and manages an AsyncBatcher instance.

Expand Down
5 changes: 3 additions & 2 deletions docs/framework/angular/reference/functions/injectAsyncDebouncedCallback.md
View file
Open in desktop
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: [async-debouncer/injectAsyncDebouncedCallback.ts:40](https://github.com/TanStack/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 Expand Up @@ -44,7 +44,8 @@ Consider using the `injectAsyncDebouncer` function instead.

### options

`AsyncDebouncerOptions`\<`TFn`\>
[`AngularAsyncDebouncerOptions`](../interfaces/AngularAsyncDebouncerOptions.md)\<`TFn`, \{
\}\>

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectAsyncDebouncer.md
View file
Open in desktop
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: [async-debouncer/injectAsyncDebouncer.ts:119](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-debouncer/injectAsyncDebouncer.ts#L119)

An Angular function that creates and manages an AsyncDebouncer instance.

Expand Down
6 changes: 3 additions & 3 deletions docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md
View file
Open in desktop
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: [async-queuer/injectAsyncQueuedSignal.ts:66](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts#L66)

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 All @@ -23,7 +23,7 @@ All queue operations are reflected in the state array returned by the function.
The function returns a callable object:
- `queued()`: Get the current queue items as an array
- `queued.addItem(...)`: Add an item to the queue
- `queued.queue`: The queuer instance with additional control methods
- `queued.queuer`: The queuer instance with additional control methods

@coderabbitai coderabbitai Bot Jul 14, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Correct the repeated singular wording.

Both descriptions list multiple controls (start() and stop()) but say “additional control method.”

  • docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md#L26-L26: change “additional control method” to “additional control methods.”
  • docs/framework/angular/reference/functions/injectQueuedSignal.md#L26-L26: make the same pluralization correction.
🧰 Tools
🪛 LanguageTool

[grammar] ~26-~26: Ensure spelling is correct
Context: ...tem to the queue - queued.queuer: The queuer instance with additional control method...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

📍 Affects 2 files
  • docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md#L26-L26 (this comment)
  • docs/framework/angular/reference/functions/injectQueuedSignal.md#L26-L26
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md` at
line 26, Update the queued.queuer descriptions in
docs/framework/angular/reference/functions/injectAsyncQueuedSignal.md:26-26 and
docs/framework/angular/reference/functions/injectQueuedSignal.md:26-26, changing
“additional control method” to “additional control methods” in both locations.

Source: Linters/SAST tools


## Type Parameters

Expand All @@ -43,7 +43,7 @@ The function returns a callable object:

### options

`AsyncQueuerOptions`\<`TValue`\> = `{}`
[`AngularAsyncQueuerOptions`](../interfaces/AngularAsyncQueuerOptions.md)\<`TValue`, `TSelected`\> = `{}`

### selector

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectAsyncQueuer.md
View file
Open in desktop
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: [async-queuer/injectAsyncQueuer.ts:96](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-queuer/injectAsyncQueuer.ts#L96)

An Angular function that creates and manages an AsyncQueuer instance.

Expand Down
5 changes: 3 additions & 2 deletions docs/framework/angular/reference/functions/injectAsyncRateLimitedCallback.md
View file
Open in desktop
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: [async-rate-limiter/injectAsyncRateLimitedCallback.ts:43](https://github.com/TanStack/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 Expand Up @@ -40,7 +40,8 @@ Consider using the `injectAsyncRateLimiter` function instead.

### options

`AsyncRateLimiterOptions`\<`TFn`\>
[`AngularAsyncRateLimiterOptions`](../interfaces/AngularAsyncRateLimiterOptions.md)\<`TFn`, \{
\}\>

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectAsyncRateLimiter.md
View file
Open in desktop
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: [async-rate-limiter/injectAsyncRateLimiter.ts:83](https://github.com/TanStack/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
5 changes: 3 additions & 2 deletions docs/framework/angular/reference/functions/injectAsyncThrottledCallback.md
View file
Open in desktop
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: [async-throttler/injectAsyncThrottledCallback.ts:41](https://github.com/TanStack/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 Expand Up @@ -42,7 +42,8 @@ Consider using the `injectAsyncThrottler` function instead.

### options

`AsyncThrottlerOptions`\<`TFn`\>
[`AngularAsyncThrottlerOptions`](../interfaces/AngularAsyncThrottlerOptions.md)\<`TFn`, \{
\}\>

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectAsyncThrottler.md
View file
Open in desktop
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: [async-throttler/injectAsyncThrottler.ts:98](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/async-throttler/injectAsyncThrottler.ts#L98)

An Angular function that creates and manages an AsyncThrottler instance.

Expand Down
5 changes: 3 additions & 2 deletions docs/framework/angular/reference/functions/injectBatchedCallback.md
View file
Open in desktop
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: [batcher/injectBatchedCallback.ts:40](https://github.com/TanStack/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 Expand Up @@ -42,7 +42,8 @@ Consider using the `injectBatcher` function instead.

### options

`BatcherOptions`\<`TValue`\>
[`AngularBatcherOptions`](../interfaces/AngularBatcherOptions.md)\<`TValue`, \{
\}\>

## Returns

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectBatcher.md
View file
Open in desktop
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: [batcher/injectBatcher.ts:85](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/batcher/injectBatcher.ts#L85)

An Angular function that creates and manages a Batcher instance.

Expand Down
5 changes: 3 additions & 2 deletions docs/framework/angular/reference/functions/injectDebouncedCallback.md
View file
Open in desktop
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: [debouncer/injectDebouncedCallback.ts:40](https://github.com/TanStack/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 Expand Up @@ -43,7 +43,8 @@ Consider using the `injectDebouncer` function instead.

### options

`DebouncerOptions`\<`TFn`\>
[`AngularDebouncerOptions`](../interfaces/AngularDebouncerOptions.md)\<`TFn`, \{
\}\>

## Returns

Expand Down
4 changes: 2 additions & 2 deletions docs/framework/angular/reference/functions/injectDebouncedSignal.md
View file
Open in desktop
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: [debouncer/injectDebouncedSignal.ts:63](https://github.com/TanStack/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 Expand Up @@ -64,7 +64,7 @@ Available debouncer state properties:

### initialOptions

`DebouncerOptions`\<`Setter`\<`TValue`\>\>
[`AngularDebouncerOptions`](../interfaces/AngularDebouncerOptions.md)\<`Setter`\<`TValue`\>, `TSelected`\>

### selector?

Expand Down
8 changes: 4 additions & 4 deletions docs/framework/angular/reference/functions/injectDebouncedValue.md
View file
Open in desktop
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: [debouncer/injectDebouncedValue.ts:75](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedValue.ts#L75)

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 @@ -69,7 +69,7 @@ Available debouncer state properties:

#### initialOptions

`DebouncerOptions`\<`Setter`\<`TValue`\>\>
[`AngularDebouncerOptions`](../interfaces/AngularDebouncerOptions.md)\<`Setter`\<`TValue`\>, `TSelected`\>

#### selector?

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: [debouncer/injectDebouncedValue.ts:80](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncedValue.ts#L80)

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 @@ -178,7 +178,7 @@ Available debouncer state properties:

#### initialOptions

`DebouncerOptions`\<`Setter`\<`TValue`\>\>
[`AngularDebouncerOptions`](../interfaces/AngularDebouncerOptions.md)\<`Setter`\<`TValue`\>, `TSelected`\>

#### selector?

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectDebouncer.md
View file
Open in desktop
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: [debouncer/injectDebouncer.ts:109](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/debouncer/injectDebouncer.ts#L109)

An Angular function that creates and manages a Debouncer instance.

Expand Down
6 changes: 3 additions & 3 deletions docs/framework/angular/reference/functions/injectQueuedSignal.md
View file
Open in desktop
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: [queuer/injectQueuedSignal.ts:56](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L56)

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 All @@ -23,7 +23,7 @@ All queue operations are reflected in the state array returned by the function.
The function returns a callable object:
- `queued()`: Get the current queue items as an array
- `queued.addItem(...)`: Add an item to the queue
- `queued.queue`: The queuer instance with additional control methods
- `queued.queuer`: The queuer instance with additional control methods

## Type Parameters

Expand All @@ -43,7 +43,7 @@ The function returns a callable object:

### options

`QueuerOptions`\<`TValue`\> = `{}`
[`AngularQueuerOptions`](../interfaces/AngularQueuerOptions.md)\<`TValue`, `TSelected`\> = `{}`

### selector

Expand Down
30 changes: 16 additions & 14 deletions docs/framework/angular/reference/functions/injectQueuedValue.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ title: injectQueuedValue
function injectQueuedValue<TValue, TSelected>(
value,
options?,
selector?): QueuedSignal<TValue, TSelected>;
selector?): QueuedValueSignal<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: [queuer/injectQueuedValue.ts:51](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L51)

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 All @@ -23,9 +23,10 @@ The queued value will process changes in the order they are received, with optio
processing each change. This is useful for handling state updates that need to be processed
in a specific order, like animations or sequential UI updates.

The function returns a tuple containing:
- A Signal that provides the current queued value
- The queuer instance with control methods
The function returns a callable object containing:
- `queued()`: A signal-like function that provides the current queued value
- `queued.addItem(...)`: A method to enqueue additional values
- `queued.queuer`: The queuer instance with control methods and state

### Type Parameters

Expand All @@ -45,15 +46,15 @@ The function returns a tuple containing:

#### options?

`QueuerOptions`\<`TValue`\>
[`AngularQueuerOptions`](../interfaces/AngularQueuerOptions.md)\<`TValue`, `TSelected`\>

#### selector?

(`state`) => `TSelected`

### Returns

[`QueuedSignal`](../interfaces/QueuedSignal.md)\<`TValue`, `TSelected`\>
[`QueuedValueSignal`](../interfaces/QueuedValueSignal.md)\<`TValue`, `TSelected`\>

### Example

Expand All @@ -75,10 +76,10 @@ function injectQueuedValue<TValue, TSelected>(
value,
initialValue,
options?,
selector?): QueuedSignal<TValue, TSelected>;
selector?): QueuedValueSignal<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: [queuer/injectQueuedValue.ts:62](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L62)

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 All @@ -87,9 +88,10 @@ The queued value will process changes in the order they are received, with optio
processing each change. This is useful for handling state updates that need to be processed
in a specific order, like animations or sequential UI updates.

The function returns a tuple containing:
- A Signal that provides the current queued value
- The queuer instance with control methods
The function returns a callable object containing:
- `queued()`: A signal-like function that provides the current queued value
- `queued.addItem(...)`: A method to enqueue additional values
- `queued.queuer`: The queuer instance with control methods and state

### Type Parameters

Expand All @@ -113,15 +115,15 @@ The function returns a tuple containing:

#### options?

`QueuerOptions`\<`TValue`\>
[`AngularQueuerOptions`](../interfaces/AngularQueuerOptions.md)\<`TValue`, `TSelected`\>

#### selector?

(`state`) => `TSelected`

### Returns

[`QueuedSignal`](../interfaces/QueuedSignal.md)\<`TValue`, `TSelected`\>
[`QueuedValueSignal`](../interfaces/QueuedValueSignal.md)\<`TValue`, `TSelected`\>

### Example

Expand Down
2 changes: 1 addition & 1 deletion docs/framework/angular/reference/functions/injectQueuer.md
View file
Open in desktop
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: [queuer/injectQueuer.ts:90](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuer.ts#L90)

An Angular function that creates and manages a Queuer instance.

Expand Down
Loading