OctaneRateLimiter

Defined in: rate-limiter/useRateLimiter.ts:25

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> & OctaneRateLimiterOptions<TFn, TSelected>;

Defined in: rate-limiter/useRateLimiter.ts:29

setOptions#

setOptions: (options) => void;

Defined in: rate-limiter/useRateLimiter.ts:31

Parameters#

options#

Partial<OctaneRateLimiterOptions<TFn, TSelected>>

Returns#

void

state#

readonly state: Readonly<TSelected>;

Defined in: rate-limiter/useRateLimiter.ts:37

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

Subscribe#

Subscribe: OctanePacerSubscribe<RateLimiterState>;

Defined in: rate-limiter/useRateLimiter.ts:35

Selects state in a child without subscribing the utility owner.