Skip to content

Commit a816fbc

Browse files
committed
docs: update angular generated docs
1 parent c14701d commit a816fbc

File tree

7 files changed

+110
-27
lines changed

7 files changed

+110
-27
lines changed

docs/framework/angular/reference/functions/injectQueuedValue.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ title: injectQueuedValue
1111
function injectQueuedValue<TValue, TSelected>(
1212
value,
1313
options?,
14-
selector?): QueuedSignal<TValue, TSelected>;
14+
selector?): QueuedValueSignal<TValue, TSelected>;
1515
```
1616

17-
Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:31](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L31)
17+
Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:38](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L38)
1818

1919
An Angular function that creates a queued value that processes state changes in order with an optional delay.
2020
This function uses injectQueuedSignal internally to manage a queue of state changes and apply them sequentially.
@@ -23,9 +23,10 @@ The queued value will process changes in the order they are received, with optio
2323
processing each change. This is useful for handling state updates that need to be processed
2424
in a specific order, like animations or sequential UI updates.
2525

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

3031
### Type Parameters
3132

@@ -53,7 +54,7 @@ The function returns a tuple containing:
5354

5455
### Returns
5556

56-
[`QueuedSignal`](../interfaces/QueuedSignal.md)\<`TValue`, `TSelected`\>
57+
[`QueuedValueSignal`](../interfaces/QueuedValueSignal.md)\<`TValue`, `TSelected`\>
5758

5859
### Example
5960

@@ -75,10 +76,10 @@ function injectQueuedValue<TValue, TSelected>(
7576
value,
7677
initialValue,
7778
options?,
78-
selector?): QueuedSignal<TValue, TSelected>;
79+
selector?): QueuedValueSignal<TValue, TSelected>;
7980
```
8081

81-
Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:42](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L42)
82+
Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:49](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L49)
8283

8384
An Angular function that creates a queued value that processes state changes in order with an optional delay.
8485
This function uses injectQueuedSignal internally to manage a queue of state changes and apply them sequentially.
@@ -87,9 +88,10 @@ The queued value will process changes in the order they are received, with optio
8788
processing each change. This is useful for handling state updates that need to be processed
8889
in a specific order, like animations or sequential UI updates.
8990

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

9496
### Type Parameters
9597

@@ -121,7 +123,7 @@ The function returns a tuple containing:
121123

122124
### Returns
123125

124-
[`QueuedSignal`](../interfaces/QueuedSignal.md)\<`TValue`, `TSelected`\>
126+
[`QueuedValueSignal`](../interfaces/QueuedValueSignal.md)\<`TValue`, `TSelected`\>
125127

126128
### Example
127129

docs/framework/angular/reference/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ title: "@tanstack/angular-pacer"
3030
- [AsyncQueuedSignal](interfaces/AsyncQueuedSignal.md)
3131
- [DebouncedSignal](interfaces/DebouncedSignal.md)
3232
- [QueuedSignal](interfaces/QueuedSignal.md)
33+
- [QueuedValueSignal](interfaces/QueuedValueSignal.md)
3334
- [RateLimitedSignal](interfaces/RateLimitedSignal.md)
3435
- [ThrottledSignal](interfaces/ThrottledSignal.md)
3536

docs/framework/angular/reference/interfaces/AsyncQueuedSignal.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Defined in: [angular-pacer/src/async-queuer/injectAsyncQueuedSignal.ts:10](https
3333
### addItem()
3434

3535
```ts
36-
addItem: (item, position?, runOnItemsChange?) => boolean;
36+
addItem: (item, position, runOnItemsChange) => boolean;
3737
```
3838

3939
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)
@@ -47,13 +47,13 @@ Items can be inserted based on priority or at the front/back depending on config
4747

4848
`TValue`
4949

50-
##### position?
50+
##### position
5151

52-
`QueuePosition`
52+
`QueuePosition` = `...`
5353

54-
##### runOnItemsChange?
54+
##### runOnItemsChange
5555

56-
`boolean`
56+
`boolean` = `true`
5757

5858
#### Returns
5959

docs/framework/angular/reference/interfaces/QueuedSignal.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:7](https://github.co
3333
### addItem()
3434

3535
```ts
36-
addItem: (item, position?, runOnItemsChange?) => boolean;
36+
addItem: (item, position, runOnItemsChange) => boolean;
3737
```
3838

3939
Defined in: [angular-pacer/src/queuer/injectQueuedSignal.ts:8](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedSignal.ts#L8)
@@ -55,13 +55,13 @@ queuer.addItem('task2', 'front');
5555

5656
`TValue`
5757

58-
##### position?
58+
##### position
5959

60-
`QueuePosition`
60+
`QueuePosition` = `...`
6161

62-
##### runOnItemsChange?
62+
##### runOnItemsChange
6363

64-
`boolean`
64+
`boolean` = `true`
6565

6666
#### Returns
6767

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
id: QueuedValueSignal
3+
title: QueuedValueSignal
4+
---
5+
6+
# Interface: QueuedValueSignal()\<TValue, TSelected\>
7+
8+
Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:7](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L7)
9+
10+
## Type Parameters
11+
12+
### TValue
13+
14+
`TValue`
15+
16+
### TSelected
17+
18+
`TSelected` = \{
19+
\}
20+
21+
```ts
22+
QueuedValueSignal(): TValue;
23+
```
24+
25+
Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:8](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L8)
26+
27+
## Returns
28+
29+
`TValue`
30+
31+
## Properties
32+
33+
### addItem()
34+
35+
```ts
36+
addItem: (item, position, runOnItemsChange) => boolean;
37+
```
38+
39+
Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:9](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L9)
40+
41+
Adds an item to the queue. If the queue is full, the item is rejected and onReject is called.
42+
Items can be inserted based on priority or at the front/back depending on configuration.
43+
44+
Returns true if the item was added, false if the queue is full.
45+
46+
Example usage:
47+
```ts
48+
queuer.addItem('task');
49+
queuer.addItem('task2', 'front');
50+
```
51+
52+
#### Parameters
53+
54+
##### item
55+
56+
`TValue`
57+
58+
##### position
59+
60+
`QueuePosition` = `...`
61+
62+
##### runOnItemsChange
63+
64+
`boolean` = `true`
65+
66+
#### Returns
67+
68+
`boolean`
69+
70+
***
71+
72+
### queuer
73+
74+
```ts
75+
queuer: AngularQueuer<TValue, TSelected>;
76+
```
77+
78+
Defined in: [angular-pacer/src/queuer/injectQueuedValue.ts:10](https://github.com/TanStack/pacer/blob/main/packages/angular-pacer/src/queuer/injectQueuedValue.ts#L10)

packages/angular-pacer/src/queuer/injectQueuedValue.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ export interface QueuedValueSignal<TValue, TSelected = {}> {
1818
* processing each change. This is useful for handling state updates that need to be processed
1919
* in a specific order, like animations or sequential UI updates.
2020
*
21-
* The function returns a tuple containing:
22-
* - A Signal that provides the current queued value
23-
* - The queuer instance with control methods
21+
* The function returns a callable object containing:
22+
* - `queued()`: A signal-like function that provides the current queued value
23+
* - `queued.addItem(...)`: A method to enqueue additional values
24+
* - `queued.queuer`: The queuer instance with control methods and state
2425
*
2526
* @example
2627
* ```ts

packages/angular-pacer/tsconfig.docs.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
{
2-
"extends": "./tsconfig.json",
2+
"extends": "./tsconfig.lib.json",
33
"compilerOptions": {
44
"paths": {
5-
"@tanstack/pacer": ["../pacer/src"]
5+
"@tanstack/pacer": ["../pacer/src"],
6+
"@tanstack/pacer/*": ["../pacer/src/*"]
67
}
78
},
89
"include": ["src"]

0 commit comments

Comments
 (0)