Skip to main content

throttleNetwork

Throttle the network capabilities of the browser. This can help to emulate certain scenarios where a user loses their internet connection and your app needs to address that.

There are many presets available with default configurations for ease of use. They are offline, GPRS, Regular2G, Good2G, Regular3G, Good3G, Regular4G, DSL, WiFi, online.

You can see the values for these presets in the source code.

info

Note that using the throttleNetwork command requires support for Chrome DevTools protocol and e.g. can not be used when running automated tests in the cloud. Find out more in the Automation Protocols section.

Usage
browser.throttleNetwork({ offline, latency, downloadThroughput, uploadThroughput })
Parameters
NameTypeDetails
paramsThrottleOptionsparameters for throttling
params.offlinebooleanTrue to emulate internet disconnection.
params.latencynumberMinimum latency from request sent to response headers received (ms).
params.downloadThroughputnumberMaximal aggregated download throughput (bytes/sec). -1 disables download throttling.
params.uploadThroughputnumberMaximal aggregated upload throughput (bytes/sec). -1 disables upload throttling.
Example
throttleNetwork.js
it('should throttle the network', async () => {
// via static string preset
await browser.throttleNetwork('Regular3G')

// via custom values
await browser.throttleNetwork({
offline: false,
downloadThroughput: 200 * 1024 / 8,
uploadThroughput: 200 * 1024 / 8,
latency: 20
})
});

Welcome! How can I help?

WebdriverIO AI Copilot