createAsyncThrottler
Function: createAsyncThrottler()
function createAsyncThrottler<TFn>(fn, initialOptions): SolidAsyncThrottler<TFn>
function createAsyncThrottler<TFn>(fn, initialOptions): SolidAsyncThrottler<TFn>
Defined in: async-throttler/createAsyncThrottler.ts:67
A low-level Solid 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 (createSignal, 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
Parameters
fn
TFn
initialOptions
AsyncThrottlerOptions<TFn>
Returns
SolidAsyncThrottler<TFn>
Example
// Basic API call throttling
const { maybeExecute } = createAsyncThrottler(
async (id: string) => {
const data = await api.fetchData(id);
return data;
},
{ wait: 1000 }
);
// With state management
const [data, setData] = createSignal(null);
const { maybeExecute } = createAsyncThrottler(
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 } = createAsyncThrottler(
async (id: string) => {
const data = await api.fetchData(id);
return data;
},
{ wait: 1000 }
);
// With state management
const [data, setData] = createSignal(null);
const { maybeExecute } = createAsyncThrottler(
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.