Defined in: react-pacer/src/rate-limiter/useRateLimiter.ts:13

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

TFn extends AnyFunction

TSelected = { }

readonly state: Readonly<TSelected>;

readonly state: Readonly<TSelected>;

Defined in: react-pacer/src/rate-limiter/useRateLimiter.ts:39

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

Use this instead of rateLimiter.store.state

readonly store: Store<Readonly<RateLimiterState>>;

readonly store: Store<Readonly<RateLimiterState>>;

Defined in: react-pacer/src/rate-limiter/useRateLimiter.ts:45

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.

Subscribe: <TSelected>(props) => ReactNode | Promise<ReactNode>;

Subscribe: <TSelected>(props) => ReactNode | Promise<ReactNode>;

Defined in: react-pacer/src/rate-limiter/useRateLimiter.ts:30

A React HOC (Higher Order Component) that allows you to subscribe to the rate limiter state.

This is useful for opting into state re-renders for specific parts of the rate limiter state deep in your component tree without needing to pass a selector to the hook.

TSelected

ReactNode | (state) => ReactNode

(state) => TSelected

ReactNode | Promise<ReactNode>

<rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
  {({ rejectionCount }) => (
    <div>Rejected: {rejectionCount} requests</div>
  )}
</rateLimiter.Subscribe>

<rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
  {({ rejectionCount }) => (
    <div>Rejected: {rejectionCount} requests</div>
  )}
</rateLimiter.Subscribe>