UseRateLimitedState

Defined in: packages/ember-pacer/src/rate-limiter/useRateLimitedState.ts:59

Creates rate-limited state with a scheduled setter.

Accepts updates while the configured limit has capacity in its fixed or sliding window. Rejected updates are discarded instead of delayed.

Return value

Yields an object with value, setValue, and utility. Read value in the template; utility exposes controls and selected state. Setters accept a value or a functional updater. Updaters run when the utility executes, using the last committed value. Pending updates may be replaced or rejected according to the utility's scheduling rules. To store a function itself, pass an updater that returns that function.

State and ownership

The value updates independently of the utility selector. The default utility selection is {}. Pass a selector to subscribe to fields such as executionCount, isPending, or status where the underlying utility exposes them.

Invoke in a Glimmer template. Positional arguments provide the callback or value and optional selector. Named arguments provide options. Removing the invocation runs cleanup. Tracked named arguments refresh options after rendering. Local options override provider defaults without replacing the utility or its pending work. onUnmount replaces default cleanup and receives the utility instance. A custom callback must perform every needed cancel, stop, or abort action.

Example

import { on } from '@ember/modifier'
import { fn } from '@ember/helper'
import { useRateLimitedState } from '@tanstack/ember-pacer'

// Inside a component template:
<template>
{{#let (useRateLimitedState 0 limit=3 window=1000) as |result|}}
  <output>{{result.value}}</output>
  <button {{on "click" (fn result.setValue 1)}}>Update</button>
{{/let}}
</template>

See

useRateLimiter

Extends

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

Type Parameters

TValue

TValue

TSelected

TSelected = { }

Constructors

Constructor

new UseRateLimitedState<TValue, TSelected>(owner?): UseRateLimitedState;

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

UseRateLimitedState

Inherited from

Helper<{
  Args: {
    Positional:
      | [value: TValue]
      | [value: TValue, selector: (state: RateLimiterState) => TSelected]
    Named: EmberRateLimiterOptions<SetValue<TValue>, TSelected>
  }
  Return: EmberRateLimitedState<TValue, TSelected>
}>.constructor

Methods

compute()

compute(positional, options): EmberRateLimitedState<TValue, TSelected>;

Defined in: packages/ember-pacer/src/rate-limiter/useRateLimitedState.ts:75

Override this function when writing a class-based helper.

Parameters

positional

[TValue, (state) => TSelected?]

The positional arguments to the helper

options

EmberRateLimiterOptions<SetValue<TValue>, TSelected>

Returns

EmberRateLimitedState<TValue, TSelected>

Method

compute

Since

1.13.0

Overrides

Helper.compute