docs: cancel is optional in OnHeadersReceivedResponse (#16548)

electron · Jan 30, 2019 · 0ee1f51 · 0ee1f51
1 parent 56276d2
commit 0ee1f51
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/docs/api/web-request.md b/docs/api/web-request.md
@@ -32,7 +32,7 @@ const filter = {
 
 session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback) => {
   details.requestHeaders['User-Agent'] = 'MyAgent'
-  callback({ cancel: false, requestHeaders: details.requestHeaders })
+  callback({ requestHeaders: details.requestHeaders })
 })
 ```
 
@@ -130,7 +130,7 @@ response are visible by the time this listener is fired.
     * `responseHeaders` Object
   * `callback` Function
     * `response` Object
-      * `cancel` Boolean
+      * `cancel` Boolean (optional)
       * `responseHeaders` Object (optional) - When provided, the server is assumed
         to have responded with these headers.
       * `statusLine` String (optional) - Should be provided when overriding