injectAsyncThrottledCallback.md

id	injectAsyncThrottledCallback
title	injectAsyncThrottledCallback

Function: injectAsyncThrottledCallback()

function injectAsyncThrottledCallback<TFn>(fn, options): (...args) => Promise<Awaited<ReturnType<TFn>> | undefined>;

Defined in: angular-pacer/src/async-throttler/injectAsyncThrottledCallback.ts:41

An Angular function that creates an async throttled version of a callback function. This function is essentially a wrapper around injectAsyncThrottler that provides a simplified API for basic async throttling needs.

The throttled function will execute at most once within the specified wait time.

This function provides a simpler API compared to injectAsyncThrottler, making it ideal for basic async throttling needs. However, it does not expose the underlying AsyncThrottler instance.

For advanced usage requiring features like:

• Manual cancellation
• Access to execution counts
• Error handling callbacks
• Retry support

Consider using the injectAsyncThrottler function instead.

Type Parameters

TFn

TFn extends AnyAsyncFunction

Parameters

fn

TFn

options

AsyncThrottlerOptions<TFn>

Returns

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

Parameters

args

...Parameters<TFn>

Returns

Promise<Awaited<ReturnType<TFn>> | undefined>

Example

// Throttle an async update handler
const handleUpdate = injectAsyncThrottledCallback(
  async (data: Data) => {
    const response = await fetch('/api/update', {
      method: 'POST',
      body: JSON.stringify(data)
    });
    return response.json();
  },
  { wait: 1000 }
);

// Use in an event handler
const result = await handleUpdate(updateData);