Open History to see the last commit
1---
2id: useRateLimitedState
3title: useRateLimitedState
4---
5
6```ts
7function useRateLimitedState<TValue, TSelected>(
8 initialValue,
9 options,
10 selector?): [Readonly<ShallowRef<TValue>>, SetValue<TValue>, VueRateLimiter<SetValue<TValue>, TSelected>];
11```
12
13Defined in: [rate-limiter/useRateLimitedState.ts:38](https://github.com/TanStack/pacer/blob/main/packages/vue-pacer/src/rate-limiter/useRateLimitedState.ts#L38)
14
15Creates rate-limited state with a scheduled setter.
16
17Accepts updates while the configured limit has capacity in its fixed or sliding window. Rejected updates are discarded instead of delayed.
18
19## Return value
20
21Returns [value, setValue, utility]. The value is a readonly shallow ref; read value.value in JavaScript or bind the ref in a template. 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.
22
23## State and ownership
24
25The 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.
26
27Call during component setup or in an active effect scope. Scope disposal removes watchers and subscriptions and runs utility cleanup.
28Options accept an object with top-level getters or an options factory. Function-valued core options remain callbacks. Local options override provider defaults without replacing the utility or its pending work.
29onUnmount replaces default cleanup and receives the utility instance. A custom callback must perform every needed cancel, stop, or abort action.
30
31## Type Parameters
32
33### TValue
34
35`TValue`
36
37### TSelected
38
39`TSelected` = \{
40\}
41
42## Parameters
43
44### initialValue
45
46`TValue`
47
48### options
49
50[`VuePacerOptions`](../type-aliases/VuePacerOptions.md)\<[`VueRateLimiterOptions`](../interfaces/VueRateLimiterOptions.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\>
51
52### selector?
53
54(`state`) => `TSelected`
55
56## Returns
57
58\[`Readonly`\<`ShallowRef`\<`TValue`\>\>, `SetValue`\<`TValue`\>, [`VueRateLimiter`](../interfaces/VueRateLimiter.md)\<`SetValue`\<`TValue`\>, `TSelected`\>\]
59
60## Example
61
62```ts
63import { useRateLimitedState } from '@tanstack/vue-pacer'
64
65// During component setup:
66const [count, setCount, utility] = useRateLimitedState(0, { limit: 3, window: 1000 },
67 (state) => ({ executionCount: state.executionCount }),
68)
69setCount((previous) => previous + 1)
70// Bind count and utility.state in the component. Read count.value for the committed value.
71```
72
73## See
74
75useRateLimiter