Skip to content
Source
Sign inSign up
TanStack/pacer
Open History to see the last commit

UseQueuedState.md

141 lines3.5 KB

1---
2id: UseQueuedState
3title: UseQueuedState
4---
5​
6Defined in: [packages/ember-pacer/src/queuer/useQueuedState.ts:49](https://github.com/TanStack/pacer/blob/main/packages/ember-pacer/src/queuer/useQueuedState.ts#L49)
7​
8Exposes pending queue items together with the queue that processes them.
9​
10Retains accepted items until processing. Ordering, capacity, wait, and started options follow the underlying queue.
11​
12## Return value
13​
14Yields the queue instance. Read pending items from queue.state.items and enqueue with queue.addItem().
15​
16## State and ownership
17​
18Items are selected by default. A custom selector must retain items and may add other state fields. The returned collection contains pending items; async active items are separate.
19​
20Invoke in a Glimmer template. Positional arguments provide the callback or value and optional selector. Named arguments provide options. Removing the invocation runs cleanup.
21Tracked named arguments refresh options after rendering. Local options override provider defaults without replacing the utility or its pending work.
22onUnmount replaces default cleanup and receives the utility instance. A custom callback must perform every needed cancel, stop, or abort action.
23​
24## Example
25​
26```gts
27import { on } from '@ember/modifier'
28import { fn } from '@ember/helper'
29import { useQueuedState } from '@tanstack/ember-pacer'
30​
31// Inside a component template:
32<template>
33{{#let (useQueuedState @process wait=500) as |queue|}}
34 <button {{on "click" (fn queue.addItem 1)}}>Add</button>
35 <output>{{queue.state.items.length}}</output>
36{{/let}}
37</template>
38```
39​
40## See
41​
42useQueuer
43​
44## Extends
45​
46- `default`\<\{
47 `Args`: \{
48 `Named`: [`EmberQueuerOptions`](../interfaces/EmberQueuerOptions.md)\<`TValue`, `TSelected`\>;
49 `Positional`: \[(`item`) => `void`\] \| \[(`item`) => `void`, (`state`) => `TSelected`\];
50 \};
51 `Return`: [`EmberQueuer`](../interfaces/EmberQueuer.md)\<`TValue`, `TSelected`\>;
52\}\>
53​
54## Type Parameters
55​
56### TValue
57​
58`TValue`
59​
60### TSelected
61​
62`TSelected` *extends* `Pick`\<`QueuerState`\<`TValue`\>, `"items"`\> = `Pick`\<`QueuerState`\<`TValue`\>, `"items"`\>
63​
64## Constructors
65​
66### Constructor
67​
68```ts
69new UseQueuedState<TValue, TSelected>(owner?): UseQueuedState;
70```
71​
72Defined in: node\_modules/.pnpm/ember-source@7.3.0\_@glimmer+component@2.1.1\_supports-color@7.2.0\_\_supports-color@7.2.0/node\_modules/ember-source/types/stable/@ember/object/index.d.ts:28
73​
74#### Parameters
75​
76##### owner?
77​
78`Owner`
79​
80#### Returns
81​
82`UseQueuedState`
83​
84#### Inherited from
85​
86```ts
87Helper<{
88 Args: {
89 Positional:
90 | [fn: (item: TValue) => void]
91 | [
92 fn: (item: TValue) => void,
93 selector: (state: QueuerState<TValue>) => TSelected,
94 ]
95 Named: EmberQueuerOptions<TValue, TSelected>
96 }
97 Return: EmberQueuer<TValue, TSelected>
98}>.constructor
99```
100​
101## Methods
102​
103### compute()
104​
105```ts
106compute(positional, options): EmberQueuer<TValue, TSelected>;
107```
108​
109Defined in: [packages/ember-pacer/src/queuer/useQueuedState.ts:75](https://github.com/TanStack/pacer/blob/main/packages/ember-pacer/src/queuer/useQueuedState.ts#L75)
110​
111Override this function when writing a class-based helper.
112​
113#### Parameters
114​
115##### positional
116​
117\[(`item`) => `void`, (`state`) => `TSelected`\]
118​
119The positional arguments to the helper
120​
121##### options
122​
123[`EmberQueuerOptions`](../interfaces/EmberQueuerOptions.md)\<`TValue`, `TSelected`\>
124​
125#### Returns
126​
127[`EmberQueuer`](../interfaces/EmberQueuer.md)\<`TValue`, `TSelected`\>
128​
129#### Method
130​
131compute
132​
133#### Since
134​
1351.13.0
136​
137#### Overrides
138​
139```ts
140Helper.compute
141```