Skip to content

Commit 4fc6cf4

Browse files
committed
Document enableNetworkEmulation defaults
1 parent ad3dc37 commit 4fc6cf4

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/api/session.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -212,10 +212,14 @@ Sets download saving directory. By default, the download directory will be the
212212
#### `ses.enableNetworkEmulation(options)`
213213

214214
* `options` Object
215-
* `offline` Boolean - Whether to emulate network outage.
216-
* `latency` Double - RTT in ms
217-
* `downloadThroughput` Double - Download rate in Bps
218-
* `uploadThroughput` Double - Upload rate in Bps
215+
* `offline` Boolean (optional) - Whether to emulate network outage. Defaults
216+
to false.
217+
* `latency` Double (optional) - RTT in ms. Defaults to 0 which will disable
218+
latency throttling.
219+
* `downloadThroughput` Double (optional) - Download rate in Bps. Defaults to 0
220+
which will disable download throttling.
221+
* `uploadThroughput` Double (optional) - Upload rate in Bps. Defaults to 0
222+
which will disable upload throttling.
219223

220224
Emulates network with the given configuration for the `session`.
221225

0 commit comments

Comments
 (0)