Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Throttle

Hierarchy

  • Throttle

Index

Constructors

constructor

  • new Throttle(limitBytes: number, flushIntervalMs?: number): Throttle

Properties

currentBytes

currentBytes: number = 0

flushIntervalMs

flushIntervalMs: number

Optional interval

interval: ReturnType<typeof setInterval>

limitBytes

limitBytes: number

logs

logs: ThrottlingLog[] = []

Methods

checkAndStack

  • checkAndStack(bytes: number): boolean

computeCapacity

  • computeCapacity(): { carryover: number; consumed: number }
  • Returns { carryover: number; consumed: number }

    • carryover: number
    • consumed: number

simpleReport

  • simpleReport(unitMs?: number): { avgBytesPerUnit: number; maxBytesPerUnit: number }
  • Parameters

    • Default value unitMs: number = 1000

    Returns { avgBytesPerUnit: number; maxBytesPerUnit: number }

    • avgBytesPerUnit: number
    • maxBytesPerUnit: number

start

  • start(): void

stop

  • stop(): void

Static fromMbps

  • fromMbps(mbps: number, flushIntervalMs?: number): Throttle

Generated using TypeDoc