OctaneRateLimiterOptions

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

Options for useRateLimiter, including owner cleanup.

Extends#

• RateLimiterOptions<TFn>

Type Parameters#

TFn#

TFn extends AnyFunction

TSelected#

TSelected = { }

Properties#

onUnmount?#

optional onUnmount?: (instance) => void;

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

Replaces default cleanup. Use this to flush, cancel, or stop pending work.

Parameters#

instance#

OctaneRateLimiter<TFn, TSelected>

Returns#

void