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

Defined in: rate-limiter/injectRateLimitedValue.ts:50

An Angular function that creates a rate-limited value that updates at most a certain number of times within a time window. Unlike injectRateLimitedSignal, this function automatically tracks changes to the input signal and updates the rate-limited value accordingly.

The rate-limited value will update according to the configured rate limit, blocking updates once the limit is reached until the window resets.

The function returns a rate-limited signal object containing:

• A Signal that provides the current rate-limited value
• The rate limiter instance with control methods

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.

TValue

TSelected = { }

Signal<TValue>

RateLimiterOptions<Setter<TValue>>

(state) => TSelected

RateLimitedSignal<TValue, TSelected>

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

// rateLimited() will update at most 5 times per 60 seconds
effect(() => {
  updateUI(rateLimited())
})

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

Defined in: rate-limiter/injectRateLimitedValue.ts:55

An Angular function that creates a rate-limited value that updates at most a certain number of times within a time window. Unlike injectRateLimitedSignal, this function automatically tracks changes to the input signal and updates the rate-limited value accordingly.

The rate-limited value will update according to the configured rate limit, blocking updates once the limit is reached until the window resets.

The function returns a rate-limited signal object containing:

• A Signal that provides the current rate-limited value
• The rate limiter instance with control methods

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.

TValue

TSelected = { }

Signal<TValue>

TValue

RateLimiterOptions<Setter<TValue>>

(state) => TSelected

RateLimitedSignal<TValue, TSelected>

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

// rateLimited() will update at most 5 times per 60 seconds
effect(() => {
  updateUI(rateLimited())
})