Framework
Version
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference

ReactThrottler

Interface: ReactThrottler<TFn, TSelected>

Defined in: react-pacer/src/throttler/useThrottler.ts:11

Extends

  • Omit<Throttler<TFn>, "store">

Type Parameters

TFn extends AnyFunction

TSelected = {}

Properties

state

ts
readonly state: Readonly<TSelected>;
readonly state: Readonly<TSelected>;

Defined in: react-pacer/src/throttler/useThrottler.ts:18

Reactive state that will be updated and re-rendered when the throttler state changes

Use this instead of throttler.store.state


store

ts
readonly store: Store<Readonly<ThrottlerState<TFn>>>;
readonly store: Store<Readonly<ThrottlerState<TFn>>>;

Defined in: react-pacer/src/throttler/useThrottler.ts:24

Deprecated

Use throttler.state instead of throttler.store.state if you want to read reactive state. The state on the store object is not reactive, as it has not been wrapped in a useStore hook internally. Although, you can make the state reactive by using the useStore in your own usage.