TanStack
Rate Limiter API Reference

EmberRateLimiter

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

A RateLimiter with framework-reactive selected state. All core methods remain available.

Extends

  • Omit<RateLimiter<TFn>, "options" | "setOptions">

Type Parameters

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

Properties

options

ts
options: RateLimiterOptions<TFn> & EmberRateLimiterOptions<TFn, TSelected>;

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


setOptions

ts
setOptions: (options) => void;

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

Parameters

options

Partial<EmberRateLimiterOptions<TFn, TSelected>>

Returns

void


state

ts
readonly state: Readonly<TSelected>;

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

Selected state. Pass a selector to opt in; the default selection is an empty object.


Subscribe

ts
Subscribe: EmberPacerSubscribe<RateLimiterState>;

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

Selects state in a child without subscribing the utility owner.