Class Bucket

constructor

• new Bucket(tokenLimit, interval, options?): Bucket

• Parameters

  • tokenLimit: number

  • interval: number

  • Optional options: {
        latencyRef?: {
            latency: number;
        };
        reservedTokens?: number;
    }

    • Optional latencyRef?: {
          latency: number;
      }

      • latency: number

    • Optional reservedTokens?: number

  Returns Bucket

interval

lastReset

lastSend

latencyRef

reservedTokens

timeout

tokenLimit

tokens

queue

• queue(func, priority?): void

• Add an item to the queue.

  Parameters

  • func: (() => void)

    The function to queue.

    • • (): void

      • Returns void

  • priority: boolean = false

    If true, the item will be added to the front of the queue.

  Returns void