Class RateLimiter

Hierarchy (view full)

Mutex
- RateLimiter

Index

Constructors

constructor

new RateLimiter(__namedParameters?): RateLimiter
Parameters
- __namedParameters: {
      concurrent: undefined | number;
      interval: undefined | number;
      limit: undefined | number;
  } = {}
  - concurrent: undefined | number
  - interval: undefined | number
  - limit: undefined | number
Returns RateLimiter
Overrides Mutex.constructor
- Defined in src/mutex.ts:105

Properties

`Private` count

count: number = 0

interval

interval: number

`Private` last

last: number = 0

`Protected` releases

releases: Release[]

`Protected` space

space: number

`Private` time_mutex

time_mutex: Mutex

`Private` `Optional` timer

timer?: Timeout

`Protected` used

used: number

`Static` prefixed

prefixed: string | boolean

Accessors

limit

set limit(limit): void
Parameters
- limit: number
Returns void
- Defined in src/mutex.ts:154

Methods

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
Returns this
Inherited from Mutex.addListener
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:45

cleaner

cleaner(): void
Returns void
- Defined in src/mutex.ts:137

emit

emit(event): boolean
Parameters
- event: "lock" | "unlock" | "all-clear"
Returns boolean
Overrides Mutex.emit
- Defined in src/mutex.ts:158
emit(event, __namedParameters): boolean
Parameters
- event: "wait"
- __namedParameters: {
  lock: Promise<void>;
  release: Release;
  }
  - lock: Promise<void>
  - release: Release
Returns boolean
Overrides Mutex.emit
- Defined in src/mutex.ts:159
emit(event): boolean
Parameters
- event: "time-lock" | "time-unlock" | "timer-reset"
Returns boolean
Overrides Mutex.emit
- Defined in src/mutex.ts:160
emit(event): boolean
Parameters
- event: string
Returns boolean
Overrides Mutex.emit
- Defined in src/mutex.ts:161

eventNames

eventNames(): (string | symbol)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (string | symbol)[]
Inherited from Mutex.eventNames
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:15

full

full(): boolean
Returns boolean
Inherited from Mutex.full
- Defined in src/mutex.ts:60

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: string | symbol
Returns number
Inherited from Mutex.listenerCount
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from Mutex.listeners
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:20

lock

lock(): Promise<number>
Returns Promise<number>
Overrides Mutex.lock
- Defined in src/mutex.ts:114

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from Mutex.off
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:69

on

on(event, listener): this
Parameters
- event: "lock" | "unlock" | "all-clear"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Overrides Mutex.on
- Defined in src/mutex.ts:167
on(event, listener): this
Parameters
- event: "wait"
- listener: ((__namedParameters) => void)
  - - (__namedParameters): void
    - Parameters
      __namedParameters: {
      lock: Promise<void>;
      release: Release;
      }
      lock: Promise<void>
      release: Release
      Returns void
Returns this
Overrides Mutex.on
- Defined in src/mutex.ts:168
on(event, listener): this
Parameters
- event: "time-lock" | "time-unlock" | "timer-reset"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Overrides Mutex.on
- Defined in src/mutex.ts:172
on(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: unknown[]
      Returns void
Returns this
Overrides Mutex.on
- Defined in src/mutex.ts:173

once

once(event, listener): this
Parameters
- event: "lock" | "unlock" | "all-clear"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Overrides Mutex.once
- Defined in src/mutex.ts:179
once(event, listener): this
Parameters
- event: "wait"
- listener: ((__namedParameters) => void)
  - - (__namedParameters): void
    - Parameters
      __namedParameters: {
      lock: Promise<void>;
      release: Release;
      }
      lock: Promise<void>
      release: Release
      Returns void
Returns this
Overrides Mutex.once
- Defined in src/mutex.ts:180
once(event, listener): this
Parameters
- event: "time-lock" | "time-unlock" | "timer-reset"
- listener: (() => void)
  - - (): void
    - Returns void
Returns this
Overrides Mutex.once
- Defined in src/mutex.ts:184
once(event, listener): this
Parameters
- event: string
- listener: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: unknown[]
      Returns void
Returns this
Overrides Mutex.once
- Defined in src/mutex.ts:185

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns this
Inherited from Mutex.removeAllListeners
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends string | symbol
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: any[]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from Mutex.removeListener
- Defined in node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:63

reset

reset(): void
Returns void
- Defined in src/mutex.ts:126

resize

resize(space): number
Parameters
- space: number
Returns number
Inherited from Mutex.resize
- Defined in src/mutex.ts:50

unlock

unlock(): number
Returns number
Inherited from Mutex.unlock
- Defined in src/mutex.ts:32

waiting

waiting(): number
Returns number
Inherited from Mutex.waiting
- Defined in src/mutex.ts:64

Class RateLimiter

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

concurrent: undefined | number

interval: undefined | number

limit: undefined | number

Returns RateLimiter

Properties

Private count

interval

Private last

Protected releases

Protected space

Private time_mutex

Private Optional timer

Protected used

Static prefixed

Accessors

limit

Parameters

Returns void

Methods

addListener

Type Parameters

Parameters

Parameters

Returns void

Returns this

cleaner

Returns void

emit

Parameters

Returns boolean

Parameters

lock: Promise<void>

release: Release

Returns boolean

Parameters

Returns boolean

Parameters

Returns boolean

eventNames

Returns (string | symbol)[]

full

Returns boolean

listenerCount

Parameters

Returns number

listeners

Type Parameters

Parameters

Returns ((...args) => void)[]

lock

Returns Promise<number>

off

Type Parameters

Parameters

Parameters

Returns void

Returns this

on

Parameters

Returns void

Returns this

Parameters

Parameters

lock: Promise<void>

release: Release

Returns void

Returns this

Parameters

Returns void

Returns this

`Private` count

`Private` last

`Protected` releases

`Protected` space

`Private` time_mutex

`Private` `Optional` timer

`Protected` used

`Static` prefixed