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

SolidRateLimiter

Interface: SolidRateLimiter<TFn, TSelected>

Defined in: rate-limiter/createRateLimiter.ts:11

Extends

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

Type Parameters

TFn extends AnyFunction

TSelected = {}

Properties

state

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

Defined in: rate-limiter/createRateLimiter.ts:18

Reactive state that will be updated when the rate limiter state changes

Use this instead of rateLimiter.store.state


store

ts
readonly store: Store<Readonly<RateLimiterState>>;
readonly store: Store<Readonly<RateLimiterState>>;

Defined in: rate-limiter/createRateLimiter.ts:24

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.