Class RateLimiter<T, U, V>`Abstract`

A base class to implement rate limiters with different invocation strategies.

Typeparam

T - The resolved type of the underlying function.

Typeparam

U - The rejected type of the underlying function.

Typeparam

V - Arguments for the underlying function.

Type Parameters

T
U
V extends any[]

Hierarchy

RateLimiter
- Debouncer
- Throttler

Implements

IRateLimiter<T, U, V>

Index

Constructors

constructor

new RateLimiter<T, U, V>(fn: ((...args: V) => T | Promise<T>), limit?: number): RateLimiter<T, U, V>
Instantiate a rate limiter.
Type Parameters
- T
- U
- V extends any[]
Parameters
- fn: ((...args: V) => T | Promise<T>)
  
  The function to rate limit.
  - - (...args: V): T | Promise<T>
    - Parameters
      
      Rest ...args: V
      
      Returns T | Promise<T>
- limit: number = 500
  
  The rate limit; defaults to 500ms.
Returns RateLimiter<T, U, V>
- Defined in packages/polling/src/ratelimiter.ts:29

Properties

`Protected` args

args: undefined | V = undefined

Arguments for the underlying function.

`Readonly` limit

limit: number

The rate limit in milliseconds.

`Protected` payload

payload: null | PromiseDelegate<T> = 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
Whether the rate limiter is disposed.

Returns boolean
Implementation of IRateLimiter.isDisposed
- Defined in packages/polling/src/ratelimiter.ts:63

Methods

dispose

dispose(): void
Disposes the rate limiter.

Returns void
Implementation of IRateLimiter.dispose
- Defined in packages/polling/src/ratelimiter.ts:70

`Abstract` invoke

invoke(...args: V): Promise<T>
Invoke the rate limited function.
Parameters
- Rest ...args: V
Returns Promise<T>
Implementation of IRateLimiter.invoke
- Defined in packages/polling/src/ratelimiter.ts:87

stop

stop(): Promise<void>
Stop the function if it is mid-flight.

Returns Promise<void>
Implementation of IRateLimiter.stop
- Defined in packages/polling/src/ratelimiter.ts:92

Class RateLimiter<T, U, V>Abstract

Typeparam

Typeparam

Typeparam

Type Parameters

T

U

V extends any[]

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

U

V extends any[]

Parameters

fn: ((...args: V) => T | Promise<T>)

Parameters

Rest ...args: V

Returns T | Promise<T>

limit: number = 500

Returns RateLimiter<T, U, V>

Properties

Protected args

Readonly limit

Protected payload

Protected poll

Accessors

isDisposed

Returns boolean

Methods

dispose

Returns void

Abstract invoke

Parameters

Rest ...args: V

Returns Promise<T>

stop

Returns Promise<void>

Settings

Member Visibility

Theme

Class RateLimiter<T, U, V>`Abstract`

`Rest` ...args: V

`Protected` args

`Readonly` limit

`Protected` payload

`Protected` poll

`Abstract` invoke

`Rest` ...args: V