Skip to content

Commit f23f742

Browse files
committed
update guides
1 parent 15afc8e commit f23f742

File tree

8 files changed

+11
-1
lines changed

8 files changed

+11
-1
lines changed

docs/guides/async-debouncing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,7 @@ The `AsyncDebouncerState` includes:
200200
- `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
201201
- `lastArgs`: The arguments from the most recent call to `maybeExecute`
202202
- `lastResult`: The result from the most recent successful function execution
203+
- `maybeExecuteCount`: Number of times `maybeExecute` has been called
203204
- `settleCount`: Number of function executions that have completed (either successfully or with errors)
204205
- `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')
205206
- `successCount`: Number of function executions that have completed successfully

docs/guides/async-queuing.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,8 @@ const queue = new AsyncQueuer(
9696
{
9797
concurrency: 2, // Process 2 items at once
9898
wait: 1000, // Wait 1 second between starting new items
99-
started: true // Start processing immediately
99+
started: true, // Start processing immediately
100+
key: 'data-processor' // Identify this queuer in devtools
100101
}
101102
)
102103

@@ -325,6 +326,7 @@ unsubscribe()
325326
The `AsyncQueuerState` includes all properties from the core queuing guide plus:
326327

327328
- `activeItems`: Array of items currently being processed
329+
- `addItemCount`: Number of times addItem has been called (for reduction calculations)
328330
- `errorCount`: Number of function executions that have resulted in errors
329331
- `expirationCount`: Number of items that have been removed from the queue due to expiration
330332
- `isEmpty`: Whether the queuer has no items to process (items array is empty)

docs/guides/async-rate-limiting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,7 @@ The `AsyncRateLimiterState` includes:
187187
- `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
188188
- `isExecuting`: Whether the rate-limited function is currently executing asynchronously
189189
- `lastResult`: The result from the most recent successful function execution
190+
- `maybeExecuteCount`: Number of times `maybeExecute` has been called
190191
- `rejectionCount`: Number of function executions that have been rejected due to rate limiting
191192
- `settledCount`: Number of function executions that have completed (either successfully or with errors)
192193
- `status`: Current execution status ('disabled' | 'exceeded' | 'idle')

docs/guides/async-throttling.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,7 @@ The `AsyncThrottlerState` includes:
201201
- `lastArgs`: The arguments from the most recent call to `maybeExecute`
202202
- `lastExecutionTime`: Timestamp of the last function execution in milliseconds
203203
- `lastResult`: The result from the most recent successful function execution
204+
- `maybeExecuteCount`: Number of times `maybeExecute` has been called
204205
- `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
205206
- `settleCount`: Number of function executions that have completed (either successfully or with errors)
206207
- `status`: Current execution status ('disabled' | 'idle' | 'pending' | 'executing' | 'settled')

docs/guides/debouncing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,7 @@ const initialState = savedState ? JSON.parse(savedState) : {}
243243

244244
const debouncer = new Debouncer(fn, {
245245
wait: 500,
246+
key: 'search-debouncer',
246247
initialState
247248
})
248249
```
@@ -273,6 +274,7 @@ The `DebouncerState` includes:
273274
- `executionCount`: Number of function executions that have been completed
274275
- `isPending`: Whether the debouncer is waiting for the timeout to trigger execution
275276
- `lastArgs`: The arguments from the most recent call to `maybeExecute`
277+
- `maybeExecuteCount`: Number of times `maybeExecute` has been called
276278
- `status`: Current execution status ('disabled' | 'idle' | 'pending')
277279

278280
## Framework Adapters

docs/guides/queuing.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,7 @@ unsubscribe()
473473

474474
The `QueuerState` includes:
475475

476+
- `addItemCount`: Number of times addItem has been called (for reduction calculations)
476477
- `executionCount`: Number of items that have been processed by the queuer
477478
- `expirationCount`: Number of items that have been removed from the queue due to expiration
478479
- `isEmpty`: Whether the queuer has no items to process (items array is empty)

docs/guides/rate-limiting.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -292,6 +292,7 @@ The `RateLimiterState` includes:
292292
- `executionCount`: Number of function executions that have been completed
293293
- `executionTimes`: Array of timestamps when executions occurred for rate limiting calculations
294294
- `isExceeded`: Whether the rate limiter has exceeded the limit
295+
- `maybeExecuteCount`: Number of times `maybeExecute` has been called
295296
- `rejectionCount`: Number of function executions that have been rejected due to rate limiting
296297
- `status`: Current execution status ('disabled' | 'exceeded' | 'idle')
297298

docs/guides/throttling.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ The `ThrottlerState` includes:
264264
- `isPending`: Whether the throttler is waiting for the timeout to trigger execution
265265
- `lastArgs`: The arguments from the most recent call to `maybeExecute`
266266
- `lastExecutionTime`: Timestamp of the last function execution in milliseconds
267+
- `maybeExecuteCount`: Number of times `maybeExecute` has been called
267268
- `nextExecutionTime`: Timestamp when the next execution can occur in milliseconds
268269
- `status`: Current execution status ('disabled' | 'idle' | 'pending')
269270

0 commit comments

Comments
 (0)