github/electron
1
1
Fork 0
mirror of https://github.com/electron/electron.git synced 2026-04-10 03:01:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: cancel is optional in OnHeadersReceivedResponse (#16548)

Browse Source
This commit is contained in:
trop[bot]
2019-01-29 21:09:42 -08:00
committed by Shelley Vohr
parent 56276d2102
commit 0ee1f51883
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api/web-request.md
View File

@@ -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