TanStack
Rate Limiter API Reference

AsyncRateLimiterController

Defined in: async-rate-limiter/AsyncRateLimiterController.ts:12

Owns a AsyncRateLimiter for a Lit host. Access core methods and selected state through pacer.

Type Parameters

TFn

TFn extends AnyAsyncFunction

TSelected

TSelected = { }

Constructors

Constructor

ts
new AsyncRateLimiterController<TFn, TSelected>(
   host,
   fn,
   options,
selector?): AsyncRateLimiterController<TFn, TSelected>;

Defined in: async-rate-limiter/AsyncRateLimiterController.ts:17

Parameters

host

ReactiveControllerHost

fn

TFn

options

LitPacerOptions<LitAsyncRateLimiterOptions<TFn, TSelected>>

selector?

(state) => TSelected

Returns

AsyncRateLimiterController<TFn, TSelected>

Properties

pacer

ts
readonly pacer: LitAsyncRateLimiter<TFn, TSelected>;

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

Accessors

state

Get Signature

ts
get state(): Readonly<TSelected>;

Defined in: async-rate-limiter/AsyncRateLimiterController.ts:27

Selected reactive state. Reading this property participates in host rendering.

Returns

Readonly<TSelected>