TanStack

AngularQueuerItems

Defined in: packages/angular-pacer/src/queuer/injectQueuerItems.ts:13

A readonly signal of pending queue items, with the Angular queuer attached.

Extends

  • Signal<ReadonlyArray<TValue>>

Type Parameters

TValue

TValue

TSelected

TSelected = { }

ts
AngularQueuerItems(): readonly TValue[];

Defined in: packages/angular-pacer/src/queuer/injectQueuerItems.ts:13

A readonly signal of pending queue items, with the Angular queuer attached.

Returns

readonly TValue[]

Properties

[SIGNAL]

ts
[SIGNAL]: unknown;

Defined in: node_modules/.pnpm/@angular+core@22.2.1_@angular+compiler@22.2.1_rxjs@7.8.2_zone.js@0.16.3/node_modules/@angular/core/types/_chrome_dev_tools_performance-chunk.d.ts:75

Inherited from

ts
Signal.[SIGNAL]

addItem

ts
addItem: (item, position, runOnItemsChange) => boolean;

Defined in: packages/angular-pacer/src/queuer/injectQueuerItems.ts:19

Shortcut for queuer.addItem, with the same arguments and return value.

Adds an item to the queue. If the queue is full, the item is rejected and onReject is called. undefined cannot be queued (it is the internal "no item" sentinel) and is always rejected. Items can be inserted based on priority or at the front/back depending on configuration.

Returns true if the item was added, false if the queue is full.

Example usage:

ts
queuer.addItem('task');
queuer.addItem('task2', 'front');

Parameters

item

TValue

position?

QueuePosition = ...

runOnItemsChange?

boolean = true

Returns

boolean


queuer

ts
queuer: AngularQueuer<TValue, TSelected>;

Defined in: packages/angular-pacer/src/queuer/injectQueuerItems.ts:17

The underlying utility ref for adding, processing, and inspecting items.