injectAsyncRateLimiter

function injectAsyncRateLimiter<TFn, TSelected>(
   fn,
   options,
selector?): AngularAsyncRateLimiter<TFn, TSelected>;

Defined in: async-rate-limiter/injectAsyncRateLimiter.ts:90

An Angular function that creates and manages an AsyncRateLimiter instance.

This is a lower-level function that provides direct access to the AsyncRateLimiter's functionality. This allows you to integrate it with any state management solution you prefer.

This function provides async rate limiting functionality with promise support, error handling, retry capabilities, and abort support.

State Management and Selector

The function uses TanStack Store for state management and wraps it with Angular signals. The selector parameter allows you to specify which state changes will trigger signal updates, optimizing performance by preventing unnecessary updates when irrelevant state changes occur.

By default, there will be no reactive state subscriptions and you must opt-in to state tracking by providing a selector function. This prevents unnecessary updates and gives you full control over when your component tracks state changes.

Cleanup on Destroy

By default, the function aborts in-flight work when the component is destroyed. Use the onUnmount option to customize this.

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Parameters

fn

TFn

options

AngularPacerOptions<AngularAsyncRateLimiterOptions<TFn, TSelected>>

selector?

(state) => TSelected

Returns

AngularAsyncRateLimiter<TFn, TSelected>

Example

// Default behavior - no reactive state subscriptions
const rateLimiter = injectAsyncRateLimiter(
  async (id: string) => {
    const response = await fetch(`/api/data/${id}`);
    return response.json();
  },
  { limit: 5, window: 60000, windowType: 'sliding' }
);

// In an event handler
const handleRequest = async (id: string) => {
  const result = await rateLimiter.maybeExecute(id);
  console.log('Result:', result);
};