Interface IRateLimiter<T, U, V>

A function whose invocations are rate limited and can be stopped after invocation before it has fired.

Type parameters

T

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

The rejected type of the underlying function. Defaults to any.
V: any[]

Arguments for the underlying function. Defaults to any[].

Hierarchy

IDisposable
- IRateLimiter

Implemented by

Index

Properties

Methods

Properties

isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

limit

limit: number

The rate limit in milliseconds.

Methods

dispose

dispose(): void

Inherited from IDisposable.dispose
- Defined in disposable/types/index.d.ts:25
Dispose of the resources held by the object.

Notes

If the object's dispose method is called more than once, all calls made after the first will be a no-op.

Undefined Behavior

It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

Returns void

invoke

invoke(...args: V): Promise<T>

- Defined in polling/src/index.ts:176
Invoke the rate limited function.

Parameters
- Rest ...args: V
Returns Promise<T>

stop

stop(): Promise<void>

- Defined in polling/src/index.ts:181
Stop the function if it is mid-flight.

Returns Promise<void>

Generated using TypeDoc