Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Bucket

Hierarchy

  • Bucket

Index

Constructors

Properties

Methods

Constructors

constructor

  • new Bucket(limit?: number, delay?: number, wait?: boolean): Bucket

  • Parameters

    • limit: number = 0
    • delay: number = 0
    • wait: boolean = false

    Returns Bucket

Properties

delay

delay: number

executing

executing: boolean = false

limit

limit: number

locked

locked: boolean = false

Readonly queue

queue: Function[] = []

sent

sent: { amount: number; last: number } = ...

Type declaration

  • amount: number
  • last: number

Readonly timeout

timeout: Timeout = ...

wait

wait: boolean

Methods

add

  • add(throttled: Function, unshift?: boolean): void

  • Parameters

    • throttled: Function
    • unshift: boolean = false

    Returns void

clear

  • clear(): void

lock

  • lock(unlockIn?: number): void

shift

  • shift(): void

tryLock

  • tryLock(): void

unlock

  • unlock(): void

Generated using TypeDoc