Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Fix types and missing property in WebRequest APIs (backport: 5-0-x) #17167

Merged
merged 3 commits into from Feb 28, 2019
Merged

docs: Fix types and missing property in WebRequest APIs (backport: 5-0-x) #17167

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
45ff7c0
docs: Fixed hook methods of WebRequest accepts null as listener
rhysd Feb 19, 2019
dae7a09
docs: Added missing `referrer` property in OnBeforeRequestDetails
rhysd Feb 19, 2019
67a9b87
docs: Add `referrer` to each webRequest responses
rhysd Feb 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 15 additions & 8 deletions docs/api/web-request.md
View file
Open in desktop
Expand Up @@ -45,13 +45,14 @@ The following methods are available on instances of `WebRequest`:
* `filter` Object (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
requests that do not match the URL patterns.
* `listener` Function
* `listener` Function | null
* `details` Object
* `id` Integer
* `url` String
* `method` String
* `webContentsId` Integer (optional)
* `resourceType` String
* `referrer` String
* `timestamp` Double
* `uploadData` [UploadData[]](structures/upload-data.md)
* `callback` Function
Expand All @@ -72,13 +73,14 @@ The `callback` has to be called with an `response` object.
* `filter` Object (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
requests that do not match the URL patterns.
* `listener` Function
* `listener` Function | null
* `details` Object
* `id` Integer
* `url` String
* `method` String
* `webContentsId` Integer (optional)
* `resourceType` String
* `referrer` String
* `timestamp` Double
* `requestHeaders` Object
* `callback` Function
Expand All @@ -98,13 +100,14 @@ The `callback` has to be called with an `response` object.
* `filter` Object (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
requests that do not match the URL patterns.
* `listener` Function
* `listener` Function | null
* `details` Object
* `id` Integer
* `url` String
* `method` String
* `webContentsId` Integer (optional)
* `resourceType` String
* `referrer` String
* `timestamp` Double
* `requestHeaders` Object

Expand All @@ -117,13 +120,14 @@ response are visible by the time this listener is fired.
* `filter` Object (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
requests that do not match the URL patterns.
* `listener` Function
* `listener` Function | null
* `details` Object
* `id` Integer
* `url` String
* `method` String
* `webContentsId` Integer (optional)
* `resourceType` String
* `referrer` String
* `timestamp` Double
* `statusLine` String
* `statusCode` Integer
Expand All @@ -147,13 +151,14 @@ The `callback` has to be called with an `response` object.
* `filter` Object (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
requests that do not match the URL patterns.
* `listener` Function
* `listener` Function | null
* `details` Object
* `id` Integer
* `url` String
* `method` String
* `webContentsId` Integer (optional)
* `resourceType` String
* `referrer` String
* `timestamp` Double
* `responseHeaders` Object
* `fromCache` Boolean - Indicates whether the response was fetched from disk
Expand All @@ -170,13 +175,14 @@ and response headers are available.
* `filter` Object (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
requests that do not match the URL patterns.
* `listener` Function
* `listener` Function | null
* `details` Object
* `id` Integer
* `url` String
* `method` String
* `webContentsId` Integer (optional)
* `resourceType` String
* `referrer` String
* `timestamp` Double
* `redirectURL` String
* `statusCode` Integer
Expand All @@ -193,7 +199,7 @@ redirect is about to occur.
* `filter` Object (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
requests that do not match the URL patterns.
* `listener` Function
* `listener` Function | null
* `details` Object
* `id` Integer
* `url` String
Expand All @@ -215,13 +221,14 @@ completed.
* `filter` Object (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
requests that do not match the URL patterns.
* `listener` Function
* `listener` Function | null
* `details` Object
* `id` Integer
* `url` String
* `method` String
* `webContentsId` Integer (optional)
* `resourceType` String
* `referrer` String
* `timestamp` Double
* `fromCache` Boolean
* `error` String - The error description.
Expand Down