Class RateLimiter

Hierarchy

Semaphore
- RateLimiter

Index

Constructors

constructor

new RateLimiter(__namedParameters?: {
    concurrency: undefined | number;
    interval: undefined | number;
    limit: undefined | number;
}): RateLimiter
Parameters
- __namedParameters: {
      concurrency: undefined | number;
      interval: undefined | number;
      limit: undefined | number;
  } = {}
  - concurrency: undefined | number
  - interval: undefined | number
  - limit: undefined | number
Returns RateLimiter
Overrides Semaphore.constructor
- Defined in src/rate-limiter.ts:11

Properties

`Protected` _releases

_releases: Release[]

`Protected` _space

_space: number

`Protected` _used

_used: number

`Private` count

count: number = 0

interval

interval: number

`Private` last

last: number = 0

`Private` time_semaphore

time_semaphore: Semaphore

`Private` `Optional` timer

timer?: Timeout

`Static` prefixed

prefixed: string | boolean

Accessors

space

get space(): number
Returns number
Inherited from Semaphore.space
- Defined in src/semaphore.ts:9

used

get used(): number
Returns number
Inherited from Semaphore.used
- Defined in src/semaphore.ts:13

waiting

get waiting(): number
Returns number
Inherited from Semaphore.waiting
- Defined in src/semaphore.ts:17

Methods

addListener

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

cleaner

cleaner(): void
Returns void
- Defined in src/rate-limiter.ts:47

down

down(): number
Returns number
Inherited from Semaphore.down
- Defined in src/semaphore.ts:49

emit

emit(event: "up" | "down" | "all-clear"): boolean
Parameters
- event: "up" | "down" | "all-clear"
Returns boolean
Overrides Semaphore.emit
- Defined in src/rate-limiter.ts:61
emit(event: "wait", data: {
release: Release;
}): boolean
Parameters
- event: "wait"
- data: {
  release: Release;
  }
  - release: Release
Returns boolean
Overrides Semaphore.emit
- Defined in src/rate-limiter.ts:62
emit(event: "time-lock" | "time-unlock" | "timer-reset"): boolean
Parameters
- event: "time-lock" | "time-unlock" | "timer-reset"
Returns boolean
Overrides Semaphore.emit
- Defined in src/rate-limiter.ts:63
emit(event: string, ...args: any[]): boolean
Parameters
- event: string
- Rest ...args: any[]
Returns boolean
Overrides Semaphore.emit
- Defined in src/rate-limiter.ts:64

empty

empty(): boolean
Returns boolean
Inherited from Semaphore.empty
- Defined in src/semaphore.ts:81

eventNames

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

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

full

full(): boolean
Returns boolean
Inherited from Semaphore.full
- Defined in src/semaphore.ts:77

listenerCount

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

listeners

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

lock

lock(): Promise<number>
Returns Promise<number>
- Defined in src/rate-limiter.ts:20

off

off(event: "up" | "down" | "all-clear", listener: (() => void)): RateLimiter
Parameters
- event: "up" | "down" | "all-clear"
- listener: (() => void)
  - - (): void
    - Returns void
Returns RateLimiter
Overrides Semaphore.off
- Defined in src/rate-limiter.ts:76
off(event: "wait", listener: ((data: {
release: Release;
}) => void)): RateLimiter
Parameters
- event: "wait"
- listener: ((data: {
  release: Release;
  }) => void)
  - - (data: {
      release: Release;
      }): void
    - Parameters
      
      data: {
      release: Release;
      }
      
      release: Release
      
      Returns void
Returns RateLimiter
Overrides Semaphore.off
- Defined in src/rate-limiter.ts:77
off(event: "time-lock" | "time-unlock" | "timer-reset", listener: (() => void)): RateLimiter
Parameters
- event: "time-lock" | "time-unlock" | "timer-reset"
- listener: (() => void)
  - - (): void
    - Returns void
Returns RateLimiter
Overrides Semaphore.off
- Defined in src/rate-limiter.ts:78

on

on(event: "up" | "down" | "all-clear", listener: (() => void)): RateLimiter
Parameters
- event: "up" | "down" | "all-clear"
- listener: (() => void)
  - - (): void
    - Returns void
Returns RateLimiter
Overrides Semaphore.on
- Defined in src/rate-limiter.ts:69
on(event: "wait", listener: ((data: {
release: Release;
}) => void)): RateLimiter
Parameters
- event: "wait"
- listener: ((data: {
  release: Release;
  }) => void)
  - - (data: {
      release: Release;
      }): void
    - Parameters
      
      data: {
      release: Release;
      }
      
      release: Release
      
      Returns void
Returns RateLimiter
Overrides Semaphore.on
- Defined in src/rate-limiter.ts:70
on(event: "time-lock" | "time-unlock" | "timer-reset", listener: (() => void)): RateLimiter
Parameters
- event: "time-lock" | "time-unlock" | "timer-reset"
- listener: (() => void)
  - - (): void
    - Returns void
Returns RateLimiter
Overrides Semaphore.on
- Defined in src/rate-limiter.ts:71

once

once(event: "up" | "down" | "all-clear", listener: (() => void)): RateLimiter
Parameters
- event: "up" | "down" | "all-clear"
- listener: (() => void)
  - - (): void
    - Returns void
Returns RateLimiter
Overrides Semaphore.once
- Defined in src/rate-limiter.ts:83
once(event: "wait", listener: ((data: {
release: Release;
}) => void)): RateLimiter
Parameters
- event: "wait"
- listener: ((data: {
  release: Release;
  }) => void)
  - - (data: {
      release: Release;
      }): void
    - Parameters
      
      data: {
      release: Release;
      }
      
      release: Release
      
      Returns void
Returns RateLimiter
Overrides Semaphore.once
- Defined in src/rate-limiter.ts:84
once(event: "time-lock" | "time-unlock" | "timer-reset", listener: (() => void)): RateLimiter
Parameters
- event: "time-lock" | "time-unlock" | "timer-reset"
- listener: (() => void)
  - - (): void
    - Returns void
Returns RateLimiter
Overrides Semaphore.once
- Defined in src/rate-limiter.ts:85

removeAllListeners

removeAllListeners(event?: string | symbol): RateLimiter
Remove all listeners, or those of the specified event.
Parameters
- Optional event: string | symbol
Returns RateLimiter
Inherited from Semaphore.removeAllListeners
- Defined in node_modules/.pnpm/eventemitter3@5.0.0/node_modules/eventemitter3/index.d.ts:79

removeListener

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

reset

reset(): void
Returns void
- Defined in src/rate-limiter.ts:36

resize

resize(space: number): RateLimiter
Parameters
- space: number
Returns RateLimiter
Inherited from Semaphore.resize
- Defined in src/semaphore.ts:67

unlock

unlock(): number
Returns number
- Defined in src/rate-limiter.ts:32

up

up(): Promise<number>
Returns Promise<number>
Inherited from Semaphore.up
- Defined in src/semaphore.ts:28

Class RateLimiter

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

__namedParameters: { concurrency: undefined | number; interval: undefined | number; limit: undefined | number; } = {}

concurrency: undefined | number

interval: undefined | number

limit: undefined | number

Returns RateLimiter

Properties

Protected _releases

Protected _space

Protected _used

Private count

interval

Private last

Private time_semaphore

Private Optional timer

Static prefixed

Accessors

space

Returns number

used

Returns number

waiting

Returns number

Methods

addListener

Type Parameters

T extends string | symbol

Parameters

event: T

fn: ((...args: any[]) => void)

Parameters

Rest ...args: any[]

Returns void

Optional context: any

Returns RateLimiter

cleaner

Returns void

down

Returns number

emit

Parameters

event: "up" | "down" | "all-clear"

Returns boolean

Parameters

event: "wait"

data: { release: Release; }

release: Release

Returns boolean

Parameters

event: "time-lock" | "time-unlock" | "timer-reset"

Returns boolean

Parameters

event: string

Rest ...args: any[]

Returns boolean

empty

Returns boolean

eventNames

Returns (string | symbol)[]

full

Returns boolean

listenerCount

Parameters

event: string | symbol

Returns number

listeners

Type Parameters

T extends string | symbol

Parameters

event: T

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

__namedParameters: {
concurrency: undefined | number;
interval: undefined | number;
limit: undefined | number;
} = {}

`Protected` _releases

`Protected` _space

`Protected` _used

`Private` count

`Private` last

`Private` time_semaphore

`Private` `Optional` timer

`Static` prefixed

`Rest` ...args: any[]

`Optional` context: any

data: {
release: Release;
}

`Rest` ...args: any[]

listener: ((data: {
release: Release;
}) => void)

data: {
release: Release;
}

listener: ((data: {
release: Release;
}) => void)

data: {
release: Release;
}

listener: ((data: {
release: Release;
}) => void)

data: {
release: Release;
}

`Optional` event: string | symbol

`Optional` fn: ((...args: any[]) => void)