mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions 1

docs: cancel is optional in OnHeadersReceivedResponse (#16506)

Browse source
This commit is contained in:
Milan Burda 2019-01-25 15:41:21 +01:00 • committed by John Kleinschmidt
parent 74c29fb610
commit e2516dc808
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) => { session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback) => {
details.requestHeaders['User-Agent'] = 'MyAgent' 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 * `responseHeaders` Object
* `callback` Function * `callback` Function
* `response` Object * `response` Object
* `cancel` Boolean * `cancel` Boolean (optional)
* `responseHeaders` Object (optional) - When provided, the server is assumed * `responseHeaders` Object (optional) - When provided, the server is assumed
to have responded with these headers. to have responded with these headers.
* `statusLine` String (optional) - Should be provided when overriding * `statusLine` String (optional) - Should be provided when overriding