Browse Source

docs: `cancel` is optional in `OnHeadersReceivedResponse` (#16506)

Milan Burda 6 years ago
parent
commit
e2516dc808
1 changed files with 2 additions and 2 deletions
  1. 2 2
      docs/api/web-request.md

+ 2 - 2
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