AlpineRateLimiter

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

A RateLimiter with framework-reactive selected state. All core methods remain available.

Extends#

• Omit<RateLimiter<TFn>, "options" | "setOptions">

Type Parameters#

TFn#

TFn extends AnyFunction

TSelected#

TSelected = { }

Properties#

options#

options: RateLimiterOptions<TFn> & AlpineRateLimiterOptions<TFn, TSelected>;

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

setOptions#

setOptions: (options) => void;

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

Parameters#

options#

Partial<AlpineRateLimiterOptions<TFn, TSelected>>

Returns#

void

state#

readonly state: Readonly<TSelected>;

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

Selected state. Pass a selector to opt in; the default selection is an empty object.

subscribe#

subscribe: AlpinePacerSubscribe<RateLimiterState>;

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

Subscribes a child owner to selected state with automatic cleanup.