Skip to content

Commit e75e682

Browse files
ci: apply automated fixes
1 parent 32f3dba commit e75e682

33 files changed

Lines changed: 337 additions & 241 deletions

docs/reference/classes/asyncdebouncer.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: AsyncDebouncer
77

88
# Class: AsyncDebouncer\<TFn\>
99

10-
Defined in: [async-debouncer.ts:183](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L183)
10+
Defined in: [async-debouncer.ts:188](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L188)
1111

1212
A class that creates an async debounced function.
1313

@@ -66,7 +66,7 @@ const results = await asyncDebouncer.maybeExecute(inputElement.value);
6666
new AsyncDebouncer<TFn>(fn, initialOptions): AsyncDebouncer<TFn>
6767
```
6868

69-
Defined in: [async-debouncer.ts:195](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L195)
69+
Defined in: [async-debouncer.ts:200](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L200)
7070

7171
#### Parameters
7272

@@ -90,7 +90,7 @@ Defined in: [async-debouncer.ts:195](https://github.com/TanStack/pacer/blob/main
9090
fn: TFn;
9191
```
9292

93-
Defined in: [async-debouncer.ts:196](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L196)
93+
Defined in: [async-debouncer.ts:201](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L201)
9494

9595
***
9696

@@ -100,7 +100,7 @@ Defined in: [async-debouncer.ts:196](https://github.com/TanStack/pacer/blob/main
100100
key: string;
101101
```
102102

103-
Defined in: [async-debouncer.ts:187](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L187)
103+
Defined in: [async-debouncer.ts:192](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L192)
104104

105105
***
106106

@@ -110,7 +110,7 @@ Defined in: [async-debouncer.ts:187](https://github.com/TanStack/pacer/blob/main
110110
options: AsyncDebouncerOptions<TFn>;
111111
```
112112

113-
Defined in: [async-debouncer.ts:188](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L188)
113+
Defined in: [async-debouncer.ts:193](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L193)
114114

115115
***
116116

@@ -120,7 +120,7 @@ Defined in: [async-debouncer.ts:188](https://github.com/TanStack/pacer/blob/main
120120
readonly store: Store<Readonly<AsyncDebouncerState<TFn>>>;
121121
```
122122

123-
Defined in: [async-debouncer.ts:184](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L184)
123+
Defined in: [async-debouncer.ts:189](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L189)
124124

125125
## Methods
126126

@@ -130,7 +130,7 @@ Defined in: [async-debouncer.ts:184](https://github.com/TanStack/pacer/blob/main
130130
_emit(): void
131131
```
132132

133-
Defined in: [async-debouncer.ts:216](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L216)
133+
Defined in: [async-debouncer.ts:221](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L221)
134134

135135
Emits a change event for the async debouncer instance. Mostly useful for devtools.
136136

@@ -146,7 +146,7 @@ Emits a change event for the async debouncer instance. Mostly useful for devtool
146146
cancel(): void
147147
```
148148

149-
Defined in: [async-debouncer.ts:406](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L406)
149+
Defined in: [async-debouncer.ts:414](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L414)
150150

151151
Cancels any pending execution or aborts any execution in progress
152152

@@ -162,7 +162,7 @@ Cancels any pending execution or aborts any execution in progress
162162
flush(): Promise<undefined | ReturnType<TFn>>
163163
```
164164

165-
Defined in: [async-debouncer.ts:358](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L358)
165+
Defined in: [async-debouncer.ts:366](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L366)
166166

167167
Processes the current pending execution immediately
168168

@@ -178,7 +178,7 @@ Processes the current pending execution immediately
178178
maybeExecute(...args): Promise<undefined | ReturnType<TFn>>
179179
```
180180

181-
Defined in: [async-debouncer.ts:281](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L281)
181+
Defined in: [async-debouncer.ts:286](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L286)
182182

183183
Attempts to execute the debounced function.
184184
If a call is already in progress, it will be queued.
@@ -214,7 +214,7 @@ The error from the debounced function if no onError handler is configured
214214
reset(): void
215215
```
216216

217-
Defined in: [async-debouncer.ts:415](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L415)
217+
Defined in: [async-debouncer.ts:423](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L423)
218218

219219
Resets the debouncer state to its default values
220220

@@ -230,7 +230,7 @@ Resets the debouncer state to its default values
230230
setOptions(newOptions): void
231231
```
232232

233-
Defined in: [async-debouncer.ts:221](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L221)
233+
Defined in: [async-debouncer.ts:226](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-debouncer.ts#L226)
234234

235235
Updates the async debouncer options
236236

docs/reference/classes/asyncqueuer.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ title: AsyncQueuer
77

88
# Class: AsyncQueuer\<TValue\>
99

10-
Defined in: [async-queuer.ts:266](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L266)
10+
Defined in: [async-queuer.ts:271](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L271)
1111

1212
A flexible asynchronous queue for processing tasks with configurable concurrency, priority, and expiration.
1313

@@ -71,7 +71,7 @@ asyncQueuer.start();
7171
new AsyncQueuer<TValue>(fn, initialOptions): AsyncQueuer<TValue>
7272
```
7373

74-
Defined in: [async-queuer.ts:274](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L274)
74+
Defined in: [async-queuer.ts:279](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L279)
7575

7676
#### Parameters
7777

@@ -95,7 +95,7 @@ Defined in: [async-queuer.ts:274](https://github.com/TanStack/pacer/blob/main/pa
9595
fn: (item) => Promise<any>;
9696
```
9797

98-
Defined in: [async-queuer.ts:275](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L275)
98+
Defined in: [async-queuer.ts:280](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L280)
9999

100100
#### Parameters
101101

@@ -115,7 +115,7 @@ Defined in: [async-queuer.ts:275](https://github.com/TanStack/pacer/blob/main/pa
115115
key: string;
116116
```
117117

118-
Defined in: [async-queuer.ts:270](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L270)
118+
Defined in: [async-queuer.ts:275](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L275)
119119

120120
***
121121

@@ -125,7 +125,7 @@ Defined in: [async-queuer.ts:270](https://github.com/TanStack/pacer/blob/main/pa
125125
options: AsyncQueuerOptions<TValue>;
126126
```
127127

128-
Defined in: [async-queuer.ts:271](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L271)
128+
Defined in: [async-queuer.ts:276](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L276)
129129

130130
***
131131

@@ -135,7 +135,7 @@ Defined in: [async-queuer.ts:271](https://github.com/TanStack/pacer/blob/main/pa
135135
readonly store: Store<Readonly<AsyncQueuerState<TValue>>>;
136136
```
137137

138-
Defined in: [async-queuer.ts:267](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L267)
138+
Defined in: [async-queuer.ts:272](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L272)
139139

140140
## Methods
141141

@@ -145,7 +145,7 @@ Defined in: [async-queuer.ts:267](https://github.com/TanStack/pacer/blob/main/pa
145145
_emit(): void
146146
```
147147

148-
Defined in: [async-queuer.ts:312](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L312)
148+
Defined in: [async-queuer.ts:317](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L317)
149149

150150
Emits a change event for the async queuer instance. Mostly useful for devtools.
151151

@@ -164,7 +164,7 @@ addItem(
164164
runOnItemsChange): boolean
165165
```
166166

167-
Defined in: [async-queuer.ts:420](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L420)
167+
Defined in: [async-queuer.ts:425](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L425)
168168

169169
Adds an item to the queue. If the queue is full, the item is rejected and onReject is called.
170170
Items can be inserted based on priority or at the front/back depending on configuration.
@@ -202,7 +202,7 @@ queuer.addItem('task2', 'front');
202202
clear(): void
203203
```
204204

205-
Defined in: [async-queuer.ts:724](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L724)
205+
Defined in: [async-queuer.ts:733](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L733)
206206

207207
Removes all pending items from the queue. Does not affect active tasks.
208208

@@ -218,7 +218,7 @@ Removes all pending items from the queue. Does not affect active tasks.
218218
execute(position?): Promise<any>
219219
```
220220
221-
Defined in: [async-queuer.ts:546](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L546)
221+
Defined in: [async-queuer.ts:555](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L555)
222222
223223
Removes and returns the next item from the queue and executes the task function with it.
224224
@@ -248,7 +248,7 @@ queuer.execute('back');
248248
flush(numberOfItems, position?): Promise<void>
249249
```
250250
251-
Defined in: [async-queuer.ts:581](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L581)
251+
Defined in: [async-queuer.ts:590](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L590)
252252
253253
Processes a specified number of items to execute immediately with no wait time
254254
If no numberOfItems is provided, all items will be processed
@@ -275,7 +275,7 @@ If no numberOfItems is provided, all items will be processed
275275
flushAsBatch(batchFunction): Promise<void>
276276
```
277277
278-
Defined in: [async-queuer.ts:595](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L595)
278+
Defined in: [async-queuer.ts:604](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L604)
279279
280280
Processes all items in the queue as a batch using the provided function as an argument
281281
The queue is cleared after processing
@@ -298,7 +298,7 @@ The queue is cleared after processing
298298
getNextItem(position): undefined | TValue
299299
```
300300
301-
Defined in: [async-queuer.ts:499](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L499)
301+
Defined in: [async-queuer.ts:508](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L508)
302302
303303
Removes and returns the next item from the queue without executing the task function.
304304
Use for manual queue management. Normally, use execute() to process items.
@@ -330,7 +330,7 @@ queuer.getNextItem('back');
330330
peekActiveItems(): TValue[]
331331
```
332332
333-
Defined in: [async-queuer.ts:687](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L687)
333+
Defined in: [async-queuer.ts:696](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L696)
334334
335335
Returns the items currently being processed (active tasks).
336336
@@ -346,7 +346,7 @@ Returns the items currently being processed (active tasks).
346346
peekAllItems(): TValue[]
347347
```
348348
349-
Defined in: [async-queuer.ts:680](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L680)
349+
Defined in: [async-queuer.ts:689](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L689)
350350
351351
Returns a copy of all items in the queue, including active and pending items.
352352
@@ -362,7 +362,7 @@ Returns a copy of all items in the queue, including active and pending items.
362362
peekNextItem(position): undefined | TValue
363363
```
364364
365-
Defined in: [async-queuer.ts:670](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L670)
365+
Defined in: [async-queuer.ts:679](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L679)
366366
367367
Returns the next item in the queue without removing it.
368368
@@ -391,7 +391,7 @@ queuer.peekNextItem('back'); // back
391391
peekPendingItems(): TValue[]
392392
```
393393
394-
Defined in: [async-queuer.ts:694](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L694)
394+
Defined in: [async-queuer.ts:703](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L703)
395395
396396
Returns the items waiting to be processed (pending tasks).
397397
@@ -407,7 +407,7 @@ Returns the items waiting to be processed (pending tasks).
407407
reset(): void
408408
```
409409
410-
Defined in: [async-queuer.ts:732](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L732)
410+
Defined in: [async-queuer.ts:741](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L741)
411411
412412
Resets the queuer state to its default values
413413
@@ -423,7 +423,7 @@ Resets the queuer state to its default values
423423
setOptions(newOptions): void
424424
```
425425
426-
Defined in: [async-queuer.ts:317](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L317)
426+
Defined in: [async-queuer.ts:322](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L322)
427427
428428
Updates the queuer options. New options are merged with existing options.
429429
@@ -445,7 +445,7 @@ Updates the queuer options. New options are merged with existing options.
445445
start(): void
446446
```
447447
448-
Defined in: [async-queuer.ts:701](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L701)
448+
Defined in: [async-queuer.ts:710](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L710)
449449
450450
Starts processing items in the queue. If already running, does nothing.
451451
@@ -461,7 +461,7 @@ Starts processing items in the queue. If already running, does nothing.
461461
stop(): void
462462
```
463463
464-
Defined in: [async-queuer.ts:711](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L711)
464+
Defined in: [async-queuer.ts:720](https://github.com/TanStack/pacer/blob/main/packages/pacer/src/async-queuer.ts#L720)
465465
466466
Stops processing items in the queue. Does not clear the queue.
467467

0 commit comments

Comments
 (0)