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

ReactAsyncRateLimiter

Interface: ReactAsyncRateLimiter<TFn, TSelected>

Defined in: react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:11

Extends

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

Type Parameters

TFn extends AnyAsyncFunction

TSelected = {}

Properties

state

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

Defined in: react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:20

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

Use this instead of rateLimiter.store.state


store

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

Defined in: react-pacer/src/async-rate-limiter/useAsyncRateLimiter.ts:26

Deprecated

Use rateLimiter.state instead of rateLimiter.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.