Defined in: async-throttler.ts:76

A class that creates an async throttled function.

Throttling limits how often a function can be executed, allowing only one execution within a specified time window. Unlike debouncing which resets the delay timer on each call, throttling ensures the function executes at a regular interval regardless of how often it's called.

This is useful for rate-limiting API calls, handling scroll/resize events, or any scenario where you want to ensure a maximum execution frequency.

const throttler = new AsyncThrottler(async (value: string) => {
  await saveToAPI(value);
}, { wait: 1000 });

// Will only execute once per second no matter how often called
inputElement.addEventListener('input', () => {
  throttler.maybeExecute(inputElement.value);
});

const throttler = new AsyncThrottler(async (value: string) => {
  await saveToAPI(value);
}, { wait: 1000 });

// Will only execute once per second no matter how often called
inputElement.addEventListener('input', () => {
  throttler.maybeExecute(inputElement.value);
});

• TFn extends AnyAsyncFunction

new AsyncThrottler<TFn>(fn, initialOptions): AsyncThrottler<TFn>

new AsyncThrottler<TFn>(fn, initialOptions): AsyncThrottler<TFn>

Defined in: async-throttler.ts:89

TFn

AsyncThrottlerOptions<TFn>

AsyncThrottler<TFn>

cancel(): void

cancel(): void

Defined in: async-throttler.ts:187

Cancels any pending execution or aborts any execution in progress

void

getErrorCount(): number

getErrorCount(): number

Defined in: async-throttler.ts:237

Returns the number of times the function has errored

number

getIsExecuting(): boolean

getIsExecuting(): boolean

Defined in: async-throttler.ts:251

Returns the current executing state

boolean

getIsPending(): boolean

getIsPending(): boolean

Defined in: async-throttler.ts:244

Returns the current pending state

boolean

getLastExecutionTime(): number

getLastExecutionTime(): number

Defined in: async-throttler.ts:202

Returns the last execution time

number

getLastResult(): undefined | ReturnType<TFn>

getLastResult(): undefined | ReturnType<TFn>

Defined in: async-throttler.ts:216

Returns the last result of the debounced function

undefined | ReturnType<TFn>

getNextExecutionTime(): number

getNextExecutionTime(): number

Defined in: async-throttler.ts:209

Returns the next execution time

number

getOptions(): Required<AsyncThrottlerOptions<TFn>>

getOptions(): Required<AsyncThrottlerOptions<TFn>>

Defined in: async-throttler.ts:115

Returns the current options

Required<AsyncThrottlerOptions<TFn>>

getSettleCount(): number

getSettleCount(): number

Defined in: async-throttler.ts:230

Returns the number of times the function has settled (completed or errored)

number

getSuccessCount(): number

getSuccessCount(): number

Defined in: async-throttler.ts:223

Returns the number of times the function has been executed successfully

number

maybeExecute(...args): Promise<undefined | ReturnType<TFn>>

maybeExecute(...args): Promise<undefined | ReturnType<TFn>>

Defined in: async-throttler.ts:123

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>>

setOptions(newOptions): void

setOptions(newOptions): void

Defined in: async-throttler.ts:103

Updates the throttler options Returns the new options state

Partial<AsyncThrottlerOptions<TFn>>

void