UseRateLimiter

Defined in: packages/ember-pacer/src/rate-limiter/useRateLimiter.ts:89

Creates and retains the RateLimiter for its Ember owner.

Accepts at most a configured number of calls in a fixed or sliding window. Calls beyond the limit are rejected rather than queued. Use the state and timing methods to display capacity and retry timing.

State and subscriptions#

Pass a selector to track only the state consumed by the owner. The default selection is {}, so utility state changes do not update the owner unless it opts in. Selection uses shallow comparison. The raw store remains available for additional subscriptions. The selector is the second positional argument. Read utility.state from the template. The contextual utility.Subscribe helper selects state for a child template.

Available state fields:

• executionCount: Number of function executions that have been completed

• executionTimes: Array of timestamps when executions occurred for rate limiting calculations

• isExceeded: Whether the rate limiter has exceeded the limit

• maybeExecuteCount: Number of times maybeExecute has been called (for reduction calculations)

• rejectionCount: Number of function executions that have been rejected due to rate limiting

• status: Current execution status - 'disabled' when not active, 'executing' when executing, 'idle' when not executing, 'exceeded' when rate limit is exceeded

Options and ownership#

Tracked named arguments update options after rendering. createPacerScope supplies shared defaults through contextual helpers. Local named options override those defaults. The synchronous rate limiter has no pending timer to cancel during teardown. onUnmount replaces default cleanup and receives the same adapter instance. A custom callback must perform all required cleanup. Use flush() where supported to finish pending work.

Example#

import { on } from '@ember/modifier'
import { fn } from '@ember/helper'
import { useRateLimiter } from '@tanstack/ember-pacer'
import type { RateLimiterState } from '@tanstack/ember-pacer'

const select = (state: RateLimiterState<(value: string) => void>) => ({ executionCount: state.executionCount })

<template>
  {{#let (useRateLimiter @process select limit=5 window=1000) as |utility|}}
    <button {{on "click" (fn utility.maybeExecute "item")}}>Schedule</button>
    <span>{{utility.state.executionCount}}</span>
  {{/let}}
</template>

Extends#

• default<{ Args: { Named: EmberRateLimiterOptions<TFn, TSelected>; Positional: [TFn] | [TFn, (state) => TSelected]; }; Return: EmberRateLimiter<TFn, TSelected>; }>

Type Parameters#

TFn#

TFn extends AnyFunction

TSelected#

TSelected = { }

Constructors#

Constructor#

new UseRateLimiter<TFn, TSelected>(owner?): UseRateLimiter;

Defined in: node_modules/.pnpm/ember-source@7.3.0_@glimmer+component@2.1.1_supports-color@7.2.0__supports-color@7.2.0/node_modules/ember-source/types/stable/@ember/object/index.d.ts:28

Parameters#

owner?#

Owner

Returns#

UseRateLimiter

Inherited from#

Helper<{
  Args: {
    Positional:
      [fn: TFn] | [fn: TFn, selector: (state: RateLimiterState) => TSelected]
    Named: EmberRateLimiterOptions<TFn, TSelected>
  }
  Return: EmberRateLimiter<TFn, TSelected>
}>.constructor

Methods#

compute()#

compute(positional, options): EmberRateLimiter<TFn, TSelected>;

Defined in: packages/ember-pacer/src/rate-limiter/useRateLimiter.ts:105

Override this function when writing a class-based helper.

Parameters#

positional#

[TFn, (state) => TSelected]

The positional arguments to the helper

options#

EmberRateLimiterOptions<TFn, TSelected>

Returns#

EmberRateLimiter<TFn, TSelected>

Method#

compute

Since#

1.13.0

Overrides#

Helper.compute