TanStack
Rate Limiter API Reference

VueAsyncRateLimiterOptions

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

Options for useAsyncRateLimiter, including owner cleanup.

Extends

  • AsyncRateLimiterOptions<TFn>

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Properties

onUnmount?

ts
optional onUnmount?: (instance) => void;

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

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

Parameters

instance

VueAsyncRateLimiter<TFn, TSelected>

Returns

void