BandwidthThrottle
Defined in: src/transfers/BandwidthThrottle.ts:21
Token-bucket throttle used to pace transfer chunks.
Properties
Section titled “Properties”| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
burstBytes | readonly | number | Burst capacity in bytes available before throttling kicks in. | src/transfers/BandwidthThrottle.ts:25 |
bytesPerSecond | readonly | number | Maximum sustained transfer rate in bytes per second. | src/transfers/BandwidthThrottle.ts:23 |
Methods
Section titled “Methods”consume()
Section titled “consume()”consume(bytes: number, signal?: AbortSignal): Promise<void>;Defined in: src/transfers/BandwidthThrottle.ts:33
Consumes bytes from the bucket, awaiting refill when not enough tokens are available.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
bytes | number | Non-negative byte count being released by the throttle. |
signal? | AbortSignal | Optional abort signal that interrupts pending waits. |
Returns
Section titled “Returns”Promise<void>
Throws
Section titled “Throws”AbortError When the signal is aborted while waiting.