Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference
Throttler API Reference

ThrottlerController

Defined in: throttler/ThrottlerController.ts:9

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

Type Parameters

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

Constructors

Constructor

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

Defined in: throttler/ThrottlerController.ts:11

Parameters

host

ReactiveControllerHost

fn

TFn

options

LitPacerOptions<LitThrottlerOptions<TFn, TSelected>>

selector?

(state) => TSelected

Returns

ThrottlerController<TFn, TSelected>

Properties

pacer

ts
readonly pacer: LitThrottler<TFn, TSelected>;
readonly pacer: LitThrottler<TFn, TSelected>;

Defined in: throttler/ThrottlerController.ts:10

Accessors

state

Get Signature

ts
get state(): Readonly<TSelected>;
get state(): Readonly<TSelected>;

Defined in: throttler/ThrottlerController.ts:21

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

Returns

Readonly<TSelected>