useAsyncThrottler
Function: useAsyncThrottler()
function useAsyncThrottler<TFn, TArgs>(fn, options): AsyncThrottler<TFn, TArgs>
function useAsyncThrottler<TFn, TArgs>(fn, options): AsyncThrottler<TFn, TArgs>
Defined in: async-throttler/useAsyncThrottler.ts:44
A low-level React hook that creates an AsyncThrottler instance to limit how often an async function can execute.
This hook is designed to be flexible and state-management agnostic - it simply returns a throttler instance that you can integrate with any state management solution (useState, Redux, Zustand, Jotai, etc).
Async throttling ensures an async function executes at most once within a specified time window, regardless of how many times it is called. This is useful for rate-limiting expensive API calls, database operations, or other async tasks.
Type Parameters
• TFn extends AnyAsyncFunction
• TArgs extends any[]
Parameters
fn
TFn
options
AsyncThrottlerOptions<TFn, TArgs>
Returns
AsyncThrottler<TFn, TArgs>
Example
// Basic API call throttling
const { maybeExecute } = useAsyncThrottler(
async (id: string) => {
const data = await api.fetchData(id);
return data;
},
{ wait: 1000 }
);
// With state management
const [data, setData] = useState(null);
const { maybeExecute } = useAsyncThrottler(
async (query) => {
const result = await searchAPI(query);
setData(result);
},
{
wait: 2000,
leading: true, // Execute immediately on first call
trailing: false // Skip trailing edge updates
}
);
// Basic API call throttling
const { maybeExecute } = useAsyncThrottler(
async (id: string) => {
const data = await api.fetchData(id);
return data;
},
{ wait: 1000 }
);
// With state management
const [data, setData] = useState(null);
const { maybeExecute } = useAsyncThrottler(
async (query) => {
const result = await searchAPI(query);
setData(result);
},
{
wait: 2000,
leading: true, // Execute immediately on first call
trailing: false // Skip trailing edge updates
}
);
Subscribe to Bytes
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.