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

docs: update type for responseHeaders in the webRequest module (#18302)

Browse source 
Fixes #18298
This commit is contained in:
Samuel Attard 2019-05-15 18:20:37 -07:00 • committed by GitHub
commit 2a08bfbcc6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

10
docs/api/web-request.md
View file

@ -131,11 +131,11 @@ response are visible by the time this listener is fired.
* `timestamp` Double * `timestamp` Double
* `statusLine` String * `statusLine` String
* `statusCode` Integer * `statusCode` Integer
* `responseHeaders` Object * `responseHeaders` Record<string, string> (Optional)
* `callback` Function * `callback` Function
* `response` Object * `response` Object
* `cancel` Boolean (optional) * `cancel` Boolean (optional)
* `responseHeaders` Object (optional) - When provided, the server is assumed * `responseHeaders` Record<string, string> (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
`responseHeaders` to change header status otherwise original response `responseHeaders` to change header status otherwise original response
@ -160,7 +160,7 @@ The `callback` has to be called with an `response` object.
* `resourceType` String * `resourceType` String
* `referrer` String * `referrer` String
* `timestamp` Double * `timestamp` Double
* `responseHeaders` Object * `responseHeaders` Record<string, string> (Optional)
* `fromCache` Boolean - Indicates whether the response was fetched from disk * `fromCache` Boolean - Indicates whether the response was fetched from disk
cache. cache.
* `statusCode` Integer * `statusCode` Integer
@ -189,7 +189,7 @@ and response headers are available.
* `ip` String (optional) - The server IP address that the request was * `ip` String (optional) - The server IP address that the request was
actually sent to. actually sent to.
* `fromCache` Boolean * `fromCache` Boolean
* `responseHeaders` Object * `responseHeaders` Record<string, string> (Optional)
The `listener` will be called with `listener(details)` when a server initiated The `listener` will be called with `listener(details)` when a server initiated
redirect is about to occur. redirect is about to occur.
@ -208,7 +208,7 @@ redirect is about to occur.
* `resourceType` String * `resourceType` String
* `referrer` String * `referrer` String
* `timestamp` Double * `timestamp` Double
* `responseHeaders` Object * `responseHeaders` Record<string, string> (Optional)
* `fromCache` Boolean * `fromCache` Boolean
* `statusCode` Integer * `statusCode` Integer
* `statusLine` String * `statusLine` String