function asyncThrottle<TFn>(fn, initialOptions): (...args) => Promise<undefined | ReturnType<TFn>>

function asyncThrottle<TFn>(fn, initialOptions): (...args) => Promise<undefined | ReturnType<TFn>>

Defined in: async-throttler.ts:281

Creates an async throttled function that limits how often the function can execute. The throttled function will execute at most once per wait period, even if called multiple times. If called while executing, it will wait until execution completes before scheduling the next call.

Unlike the non-async Throttler, this async version supports returning values from the throttled function, making it ideal for API calls and other async operations where you want the result of the maybeExecute call instead of setting the result on a state variable from within the throttled function.

• TFn extends AnyAsyncFunction

TFn

Omit<AsyncThrottlerOptions<TFn>, "enabled">

Function

Attempts to execute the throttled function If a call is already in progress, it may be blocked or queued depending on the wait option

...Parameters<TFn>

Promise<undefined | ReturnType<TFn>>

const throttled = asyncThrottle(async (value: string) => {
  const result = await saveToAPI(value);
  return result; // Return value is preserved
}, { wait: 1000 });

// This will execute at most once per second
// Returns the API response directly
const result = await throttled(inputElement.value);

const throttled = asyncThrottle(async (value: string) => {
  const result = await saveToAPI(value);
  return result; // Return value is preserved
}, { wait: 1000 });

// This will execute at most once per second
// Returns the API response directly
const result = await throttled(inputElement.value);