UseThrottledValue

Defined in: packages/ember-pacer/src/throttler/useThrottledValue.ts:52

Derives a throttled value from its current source.

Limits execution to the configured wait interval. Leading and trailing execution are enabled by default, and the latest blocked update is retained for the trailing edge.

Return value

Yields an object with value, setValue, and utility. Read value in the template; utility exposes controls and selected state. Pass the current tracked value as the first positional argument. The initial value is available immediately. Source changes schedule updates on the existing utility.

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 { useThrottledValue } from '@tanstack/ember-pacer'

// Inside a component template:
<template>
{{#let (useThrottledValue @source wait=500) as |result|}}
  <output>{{result.value}}</output>
{{/let}}
</template>

See

useThrottler

Extends

• default<{ Args: { Named: EmberThrottlerOptions<(value) => void, TSelected>; Positional: [TValue] | [TValue, (state) => TSelected]; }; Return: EmberThrottledValue<TValue, TSelected>; }>

Type Parameters

TValue

TValue

TSelected

TSelected = { }

Constructors

Constructor

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

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

UseThrottledValue

Inherited from

Helper<{
  Args: {
    Positional:
      | [value: TValue]
      | [
          value: TValue,
          selector: (
            state: ThrottlerState<(value: TValue) => void>,
          ) => TSelected,
        ]
    Named: EmberThrottlerOptions<(value: TValue) => void, TSelected>
  }
  Return: EmberThrottledValue<TValue, TSelected>
}>.constructor

Methods

compute()

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

Defined in: packages/ember-pacer/src/throttler/useThrottledValue.ts:76

Override this function when writing a class-based helper.

Parameters

positional

[TValue, (state) => TSelected?]

The positional arguments to the helper

options

EmberThrottlerOptions<(value) => void, TSelected>

Returns

EmberThrottledValue<TValue, TSelected>

Method

compute

Since

1.13.0

Overrides

Helper.compute