RateLimiterController

Defined in: rate-limiter/RateLimiterController.ts:9

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

Type Parameters

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

Constructors

Constructor

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

Defined in: rate-limiter/RateLimiterController.ts:11

Parameters

host

ReactiveControllerHost

fn

TFn

options

LitPacerOptions<LitRateLimiterOptions<TFn, TSelected>>

selector?

(state) => TSelected

Returns

RateLimiterController<TFn, TSelected>

Properties

pacer

readonly pacer: LitRateLimiter<TFn, TSelected>;

Defined in: rate-limiter/RateLimiterController.ts:10

Accessors

state

Get Signature

get state(): Readonly<TSelected>;

Defined in: rate-limiter/RateLimiterController.ts:20

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

Returns

Readonly<TSelected>