From 4fc6cf48b07a2466c6719ae1cd03eaed633f53fa Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Mon, 22 Aug 2016 14:25:42 -0700 Subject: [PATCH] Document enableNetworkEmulation defaults --- docs/api/session.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/api/session.md b/docs/api/session.md index 5f0248ee3372..face8ed63da2 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -212,10 +212,14 @@ Sets download saving directory. By default, the download directory will be the #### `ses.enableNetworkEmulation(options)` * `options` Object - * `offline` Boolean - Whether to emulate network outage. - * `latency` Double - RTT in ms - * `downloadThroughput` Double - Download rate in Bps - * `uploadThroughput` Double - Upload rate in Bps + * `offline` Boolean (optional) - Whether to emulate network outage. Defaults + to false. + * `latency` Double (optional) - RTT in ms. Defaults to 0 which will disable + latency throttling. + * `downloadThroughput` Double (optional) - Download rate in Bps. Defaults to 0 + which will disable download throttling. + * `uploadThroughput` Double (optional) - Upload rate in Bps. Defaults to 0 + which will disable upload throttling. Emulates network with the given configuration for the `session`.