OctaneAsyncRateLimiterOptions

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

Options for useAsyncRateLimiter, including owner cleanup.

Extends

• AsyncRateLimiterOptions<TFn>

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Properties

onUnmount?

optional onUnmount?: (instance) => void;

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

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

Parameters

instance

OctaneAsyncRateLimiter<TFn, TSelected>

Returns

void