Browse Source

Merge pull request #6935 from electron/default-network-conditions

Default network conditions to 0.0
Cheng Zhao 8 years ago
parent
commit
4ca6587660
2 changed files with 9 additions and 5 deletions
  1. 1 1
      atom/browser/api/atom_api_session.cc
  2. 8 4
      docs/api/session.md

+ 1 - 1
atom/browser/api/atom_api_session.cc

@@ -416,7 +416,7 @@ void Session::SetDownloadPath(const base::FilePath& path) {
 void Session::EnableNetworkEmulation(const mate::Dictionary& options) {
   std::unique_ptr<brightray::DevToolsNetworkConditions> conditions;
   bool offline = false;
-  double latency, download_throughput, upload_throughput;
+  double latency = 0.0, download_throughput = 0.0, upload_throughput = 0.0;
   if (options.Get("offline", &offline) && offline) {
     conditions.reset(new brightray::DevToolsNetworkConditions(offline));
   } else {

+ 8 - 4
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`.