Skip to content

injectRateLimitedSignal.md

Latest commit

 

History

History
84 lines (58 loc) · 2.43 KB

injectRateLimitedSignal.md

File metadata and controls

84 lines (58 loc) · 2.43 KB
id injectRateLimitedSignal
title injectRateLimitedSignal

Function: injectRateLimitedSignal()

function injectRateLimitedSignal<TValue, TSelected>(
   value, 
   initialOptions, 
selector?): RateLimitedSignal<TValue, TSelected>;

Defined in: angular-pacer/src/rate-limiter/injectRateLimitedSignal.ts:57

An Angular function that creates a rate-limited state signal, combining Angular's signal with rate limiting functionality. This function provides both the current rate-limited value and methods to update it.

Rate limiting is a simple "hard limit" approach - it allows all updates until the limit is reached, then blocks subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out or intelligently collapse updates.

The function returns a callable object:

  • rateLimited(): Get the current rate-limited value
  • rateLimited.set(...): Set or update the rate-limited value (rate-limited via maybeExecute)
  • rateLimited.rateLimiter: The rate limiter instance with additional control methods and state signals

State Management and Selector

The function uses TanStack Store for reactive state management via the underlying rate limiter instance. The selector parameter allows you to specify which rate limiter state changes will trigger signal updates, optimizing performance by preventing unnecessary subscriptions 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.

Type Parameters

TValue

TValue

TSelected

TSelected = { }

Parameters

value

TValue

initialOptions

RateLimiterOptions<Setter<TValue>>

selector?

(state) => TSelected

Returns

RateLimitedSignal<TValue, TSelected>

Example

// Default behavior - no reactive state subscriptions
const rateLimited = injectRateLimitedSignal(0, {
  limit: 5,
  window: 60000,
  windowType: 'sliding'
});

// Opt-in to reactive updates when limit state changes
const rateLimited = injectRateLimitedSignal(
  0,
  { limit: 5, window: 60000 },
  (state) => ({ rejectionCount: state.rejectionCount })
);