OctaneAsyncRateLimiter

Defined in: async-rate-limiter/useAsyncRateLimiter.ts:25

An AsyncRateLimiter with framework-reactive selected state. All core methods remain available.

Extends

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

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Properties

options

options: AsyncRateLimiterOptions<TFn> & OctaneAsyncRateLimiterOptions<TFn, TSelected>;

Defined in: async-rate-limiter/useAsyncRateLimiter.ts:29

setOptions

setOptions: (options) => void;

Defined in: async-rate-limiter/useAsyncRateLimiter.ts:31

Parameters

options

Partial<OctaneAsyncRateLimiterOptions<TFn, TSelected>>

Returns

void

state

readonly state: Readonly<TSelected>;

Defined in: async-rate-limiter/useAsyncRateLimiter.ts:37

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

Subscribe

Subscribe: OctanePacerSubscribe<AsyncRateLimiterState<TFn>>;

Defined in: async-rate-limiter/useAsyncRateLimiter.ts:35

Selects state in a child without subscribing the utility owner.