Source: https://tanstack.com/pacer/latest/docs/reference/interfaces/AsyncBatcherState

TanStack

Pacer v0v0

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React

Version

Latest

Search...

+ K

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Quick Start
  
  core

• Installation
  
  core

• Devtools
  
  core

• React Adapter
  
  react

Guides

• Debouncing Guide
  
  core

• Async Debouncing Guide
  
  core

• Throttling Guide
  
  core

• Async Throttling Guide
  
  core

• Rate Limiting Guide
  
  core

• Async Rate Limiting Guide
  
  core

• Queuing Guide
  
  core

• Async Queuing Guide
  
  core

• Batching Guide
  
  core

• Async Batching Guide
  
  core

• Async Retrying Guide
  
  core

API Reference

• Core API Reference
  
  core

• React Hooks
  
  react

Debouncer API Reference

• DebouncerOptions
  
  core

• DebouncerState
  
  core

• AsyncDebouncerOptions
  
  core

• AsyncDebouncerState
  
  core

• debounce
  
  core

• asyncDebounce
  
  core

• Debouncer
  
  core

• AsyncDebouncer
  
  core

• ReactDebouncer
  
  react

• ReactAsyncDebouncer
  
  react

• useDebouncer
  
  react

• useDebouncedCallback
  
  react

• useDebouncedState
  
  react

• useDebouncedValue
  
  react

• useAsyncDebouncer
  
  react

• useAsyncDebouncedCallback
  
  react

Throttler API Reference

• ThrottlerOptions
  
  core

• ThrottlerState
  
  core

• AsyncThrottlerOptions
  
  core

• AsyncThrottlerState
  
  core

• throttle
  
  core

• asyncThrottle
  
  core

• Throttler
  
  core

• AsyncThrottler
  
  core

• ReactThrottler
  
  react

• ReactAsyncThrottler
  
  react

• useThrottler
  
  react

• useThrottledCallback
  
  react

• useThrottledState
  
  react

• useThrottledValue
  
  react

• useAsyncThrottler
  
  react

• useAsyncThrottledCallback
  
  react

Rate Limiter API Reference

• RateLimiterOptions
  
  core

• RateLimiterState
  
  core

• AsyncRateLimiterOptions
  
  core

• AsyncRateLimiterState
  
  core

• rateLimit
  
  core

• asyncRateLimit
  
  core

• RateLimiter
  
  core

• AsyncRateLimiter
  
  core

• ReactRateLimiter
  
  react

• ReactAsyncRateLimiter
  
  react

• useRateLimiter
  
  react

• useRateLimitedCallback
  
  react

• useRateLimitedState
  
  react

• useRateLimitedValue
  
  react

• useAsyncRateLimiter
  
  react

• useAsyncRateLimitedCallback
  
  react

Queue API Reference

• QueuerOptions
  
  core

• QueuerState
  
  core

• AsyncQueuerOptions
  
  core

• AsyncQueuerState
  
  core

• queue
  
  core

• asyncQueue
  
  core

• Queuer
  
  core

• AsyncQueuer
  
  core

• ReactQueuer
  
  react

• ReactAsyncQueuer
  
  react

• useQueuer
  
  react

• useQueuedState
  
  react

• useQueuedValue
  
  react

• useAsyncQueuer
  
  react

• useAsyncQueuedState
  
  react

Batcher API Reference

• BatcherOptions
  
  core

• BatcherState
  
  core

• AsyncBatcherOptions
  
  core

• AsyncBatcherState
  
  core

• batch
  
  core

• asyncBatch
  
  core

• Batcher
  
  core

• AsyncBatcher
  
  core

• ReactBatcher
  
  react

• ReactAsyncBatcher
  
  react

• useBatcher
  
  react

• useAsyncBatcher
  
  react

• useBatchedCallback
  
  react

• useAsyncBatchedCallback
  
  react

Debouncer Examples

• debounce
  
  react

• asyncDebounce
  
  react

• useDebouncer
  
  react

• useDebouncedCallback
  
  react

• useDebouncedState
  
  react

• useDebouncedValue
  
  react

• useAsyncDebouncer
  
  react

• useAsyncDebouncedCallback
  
  react

Throttler Examples

• throttle
  
  react

• asyncThrottle
  
  react

• useThrottler
  
  react

• useThrottledCallback
  
  react

• useThrottledState
  
  react

• useThrottledValue
  
  react

• useAsyncThrottler
  
  react

Rate Limiter Examples

• rateLimit
  
  react

• asyncRateLimit
  
  react

• useRateLimiter
  
  react

• useRateLimiterWithPersister
  
  react

• useRateLimitedCallback
  
  react

• useRateLimitedState
  
  react

• useRateLimitedValue
  
  react

• useAsyncRateLimiter
  
  react

• useAsyncRateLimiterWithPersister
  
  react

Queue Examples

• queue
  
  react

• useQueuer
  
  react

• useQueuerWithPersister
  
  react

• useQueuedState
  
  react

• useQueuedValue
  
  react

• useAsyncQueuer
  
  react

• useAsyncQueuedState
  
  react

Batcher Examples

• batch
  
  react

• asyncBatch
  
  react

• useBatcher
  
  react

• useAsyncBatcher
  
  react

• useBatchedCallback
  
  react

• useAsyncBatchedCallback
  
  react

TanStack Query Examples

• React Query Debounced Prefetch
  
  react

• React Query Throttled Prefetch
  
  react

• React Query Queued Prefetch
  
  react

Framework

React

Version

Latest

Menu

• Home

• Frameworks

• Contributors

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Quick Start
  
  core

• Installation
  
  core

• Devtools
  
  core

• React Adapter
  
  react

Guides

• Debouncing Guide
  
  core

• Async Debouncing Guide
  
  core

• Throttling Guide
  
  core

• Async Throttling Guide
  
  core

• Rate Limiting Guide
  
  core

• Async Rate Limiting Guide
  
  core

• Queuing Guide
  
  core

• Async Queuing Guide
  
  core

• Batching Guide
  
  core

• Async Batching Guide
  
  core

• Async Retrying Guide
  
  core

API Reference

• Core API Reference
  
  core

• React Hooks
  
  react

Debouncer API Reference

• DebouncerOptions
  
  core

• DebouncerState
  
  core

• AsyncDebouncerOptions
  
  core

• AsyncDebouncerState
  
  core

• debounce
  
  core

• asyncDebounce
  
  core

• Debouncer
  
  core

• AsyncDebouncer
  
  core

• ReactDebouncer
  
  react

• ReactAsyncDebouncer
  
  react

• useDebouncer
  
  react

• useDebouncedCallback
  
  react

• useDebouncedState
  
  react

• useDebouncedValue
  
  react

• useAsyncDebouncer
  
  react

• useAsyncDebouncedCallback
  
  react

Throttler API Reference

• ThrottlerOptions
  
  core

• ThrottlerState
  
  core

• AsyncThrottlerOptions
  
  core

• AsyncThrottlerState
  
  core

• throttle
  
  core

• asyncThrottle
  
  core

• Throttler
  
  core

• AsyncThrottler
  
  core

• ReactThrottler
  
  react

• ReactAsyncThrottler
  
  react

• useThrottler
  
  react

• useThrottledCallback
  
  react

• useThrottledState
  
  react

• useThrottledValue
  
  react

• useAsyncThrottler
  
  react

• useAsyncThrottledCallback
  
  react

Rate Limiter API Reference

• RateLimiterOptions
  
  core

• RateLimiterState
  
  core

• AsyncRateLimiterOptions
  
  core

• AsyncRateLimiterState
  
  core

• rateLimit
  
  core

• asyncRateLimit
  
  core

• RateLimiter
  
  core

• AsyncRateLimiter
  
  core

• ReactRateLimiter
  
  react

• ReactAsyncRateLimiter
  
  react

• useRateLimiter
  
  react

• useRateLimitedCallback
  
  react

• useRateLimitedState
  
  react

• useRateLimitedValue
  
  react

• useAsyncRateLimiter
  
  react

• useAsyncRateLimitedCallback
  
  react

Queue API Reference

• QueuerOptions
  
  core

• QueuerState
  
  core

• AsyncQueuerOptions
  
  core

• AsyncQueuerState
  
  core

• queue
  
  core

• asyncQueue
  
  core

• Queuer
  
  core

• AsyncQueuer
  
  core

• ReactQueuer
  
  react

• ReactAsyncQueuer
  
  react

• useQueuer
  
  react

• useQueuedState
  
  react

• useQueuedValue
  
  react

• useAsyncQueuer
  
  react

• useAsyncQueuedState
  
  react

Batcher API Reference

• BatcherOptions
  
  core

• BatcherState
  
  core

• AsyncBatcherOptions
  
  core

• AsyncBatcherState
  
  core

• batch
  
  core

• asyncBatch
  
  core

• Batcher
  
  core

• AsyncBatcher
  
  core

• ReactBatcher
  
  react

• ReactAsyncBatcher
  
  react

• useBatcher
  
  react

• useAsyncBatcher
  
  react

• useBatchedCallback
  
  react

• useAsyncBatchedCallback
  
  react

Debouncer Examples

• debounce
  
  react

• asyncDebounce
  
  react

• useDebouncer
  
  react

• useDebouncedCallback
  
  react

• useDebouncedState
  
  react

• useDebouncedValue
  
  react

• useAsyncDebouncer
  
  react

• useAsyncDebouncedCallback
  
  react

Throttler Examples

• throttle
  
  react

• asyncThrottle
  
  react

• useThrottler
  
  react

• useThrottledCallback
  
  react

• useThrottledState
  
  react

• useThrottledValue
  
  react

• useAsyncThrottler
  
  react

Rate Limiter Examples

• rateLimit
  
  react

• asyncRateLimit
  
  react

• useRateLimiter
  
  react

• useRateLimiterWithPersister
  
  react

• useRateLimitedCallback
  
  react

• useRateLimitedState
  
  react

• useRateLimitedValue
  
  react

• useAsyncRateLimiter
  
  react

• useAsyncRateLimiterWithPersister
  
  react

Queue Examples

• queue
  
  react

• useQueuer
  
  react

• useQueuerWithPersister
  
  react

• useQueuedState
  
  react

• useQueuedValue
  
  react

• useAsyncQueuer
  
  react

• useAsyncQueuedState
  
  react

Batcher Examples

• batch
  
  react

• asyncBatch
  
  react

• useBatcher
  
  react

• useAsyncBatcher
  
  react

• useBatchedCallback
  
  react

• useAsyncBatchedCallback
  
  react

TanStack Query Examples

• React Query Debounced Prefetch
  
  react

• React Query Throttled Prefetch
  
  react

• React Query Queued Prefetch
  
  react

On this page

• Interface: AsyncBatcherState<TValue>

• Type Parameters

• TValue

• Properties

• errorCount

• executeCount

• failedItems

• isEmpty

• isExecuting

• isPending

• items

• lastResult

• settleCount

• size

• status

• successCount

• totalItemsFailed

• totalItemsProcessed

AsyncBatcherState

Copy Markdown

Interface: AsyncBatcherState<TValue>
====================================

Defined in: async-batcher.ts:8

Type Parameters
--------------- ### TValue

TValue

Properties
---------- ### errorCount

ts

errorCount: number;


errorCount: number;

Defined in: async-batcher.ts:12

Number of batch executions that have resulted in errors

---

### executeCount

ts

executeCount: number;


executeCount: number;

Defined in: async-batcher.ts:16

Number of batch executions that have been executed

---

### failedItems

ts

failedItems: TValue[];


failedItems: TValue[];

Defined in: async-batcher.ts:20

Array of items that failed during batch processing

---

### isEmpty

ts

isEmpty: boolean;


isEmpty: boolean;

Defined in: async-batcher.ts:24

Whether the batcher has no items to process (items array is empty)

---

### isExecuting

ts

isExecuting: boolean;


isExecuting: boolean;

Defined in: async-batcher.ts:28

Whether a batch is currently being processed asynchronously

---

### isPending

ts

isPending: boolean;


isPending: boolean;

Defined in: async-batcher.ts:32

Whether the batcher is waiting for the timeout to trigger batch processing

---

### items

ts

items: TValue[];


items: TValue[];

Defined in: async-batcher.ts:36

Array of items currently queued for batch processing

---

### lastResult

ts

lastResult: any;


lastResult: any;

Defined in: async-batcher.ts:40

The result from the most recent batch execution

---

### settleCount

ts

settleCount: number;


settleCount: number;

Defined in: async-batcher.ts:44

Number of batch executions that have completed (either successfully or with errors)

---

### size

ts

size: number;


size: number;

Defined in: async-batcher.ts:48

Number of items currently in the batch queue

---

### status

ts

status: "idle" | "pending" | "executing" | "populated";


status: "idle" | "pending" | "executing" | "populated";

Defined in: async-batcher.ts:52

Current processing status - 'idle' when not processing, 'pending' when waiting for timeout, 'executing' when processing, 'populated' when items are present, but no wait is configured

---

### successCount

ts

successCount: number;


successCount: number;

Defined in: async-batcher.ts:56

Number of batch executions that have completed successfully

---

### totalItemsFailed

ts

totalItemsFailed: number;


totalItemsFailed: number;

Defined in: async-batcher.ts:60

Total number of items that have failed processing across all batches

---

### totalItemsProcessed

ts

totalItemsProcessed: number;


totalItemsProcessed: number;

Defined in: async-batcher.ts:64

Total number of items that have been processed across all batches

Edit on GitHub

AsyncBatcherOptions

batch

Partners Become a Partner