Class Debouncer<T, U>

Wraps and debounces a function that can be called multiple times and only executes the underlying function one interval after the last invocation.

Type parameters

T

The resolved type of the underlying function. Defaults to any.
U

The rejected type of the underlying function. Defaults to any.

Hierarchy

RateLimiter<T, U>
- Debouncer

Implements

IRateLimiter<T, U>

Index

Constructors

constructor

Properties

Accessors

isDisposed

Methods

Constructors

constructor

new Debouncer(fn: function, limit?: number): Debouncer

Inherited from RateLimiter.constructor
- Defined in ratelimiter.ts:17
Instantiate a rate limiter.

Parameters
- fn: function
  
  The function to rate limit.
  - - (): T | Promise<T>
    - Returns T | Promise<T>
- Default value limit: number = 500
  
  The rate limit; defaults to 500ms.
Returns Debouncer

Properties

limit

limit: number

The rate limit in milliseconds.

Protected payload

payload: PromiseDelegate<T> | null = null

A promise that resolves on each successful invocation.

Protected poll

poll: Poll<T, U, "invoked">

The underlying poll instance used by the rate limiter.

Accessors

isDisposed

get isDisposed(): boolean

Inherited from RateLimiter.isDisposed
- Defined in ratelimiter.ts:55
Whether the rate limiter is disposed.

Returns boolean

Methods

dispose

dispose(): void

Implementation of IRateLimiter.dispose

Inherited from RateLimiter.dispose
- Defined in ratelimiter.ts:62
Disposes the rate limiter.

Returns void

invoke

invoke(): Promise<T>

Implementation of IRateLimiter.invoke

Overrides RateLimiter.invoke
- Defined in ratelimiter.ts:111
Invokes the function and only executes after rate limit has elapsed. Each invocation resets the timer.

Returns Promise<T>

stop

stop(): Promise<void>

Implementation of IRateLimiter.stop

Inherited from RateLimiter.stop
- Defined in ratelimiter.ts:83
Stop the function if it is mid-flight.

Returns Promise<void>

Generated using TypeDoc