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

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: DebouncerOptions<TFn>

• Type Parameters

• TFn

• Properties

• enabled?

• initialState?

• key?

• leading?

• onExecute()?

• Parameters

• args

• debouncer

• Returns

• trailing?

• wait

DebouncerOptions

Copy Markdown

Interface: DebouncerOptions<TFn>
================================

Defined in: debouncer.ts:49

Options for configuring a debounced function

Type Parameters
--------------- ### TFn

TFn extends AnyFunction

Properties
---------- ### enabled?

ts

optional enabled: boolean | (debouncer) => boolean;


optional enabled: boolean | (debouncer) => boolean;

Defined in: debouncer.ts:55

Whether the debouncer is enabled. When disabled, maybeExecute will not trigger any executions. Can be a boolean or a function that returns a boolean. Defaults to true.

---

### initialState?

ts

optional initialState: Partial<DebouncerState<TFn>>;


optional initialState: Partial<DebouncerState<TFn>>;

Defined in: debouncer.ts:59

Initial state for the debouncer

---

### key?

ts

optional key: string;


optional key: string;

Defined in: debouncer.ts:64

A key to identify the debouncer. If provided, the debouncer will be identified by this key in the devtools and PacerProvider if applicable.

---

### leading?

ts

optional leading: boolean;


optional leading: boolean;

Defined in: debouncer.ts:70

Whether to execute on the leading edge of the timeout. The first call will execute immediately and the rest will wait the delay. Defaults to false.

---

### onExecute()?

ts

optional onExecute: (args, debouncer) => void;


optional onExecute: (args, debouncer) => void;

Defined in: debouncer.ts:74

Callback function that is called after the function is executed

#### Parameters ##### args

Parameters<TFn>

##### debouncer

Debouncer <TFn>

#### Returns

void

---

### trailing?

ts

optional trailing: boolean;


optional trailing: boolean;

Defined in: debouncer.ts:79

Whether to execute on the trailing edge of the timeout. Defaults to true.

---

### wait

ts

wait: number | (debouncer) => number;


wait: number | (debouncer) => number;

Defined in: debouncer.ts:85

Delay in milliseconds before executing the function. Can be a number or a function that returns a number. Defaults to 0ms

Edit on GitHub

React Hooks

DebouncerState

Partners Become a Partner