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

feat(docs): fix 'optional' wording

Browse source
This commit is contained in:
Toinane 2017-11-28 18:15:15 +01:00
parent 124667c29b
commit 59607c9a17
No known key found for this signature in database
GPG key ID: 1A3729C1B6D59115
14 changed files with 92 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -41,8 +41,8 @@ The following methods are available on instances of `WebRequest`:
#### `webRequest.onBeforeRequest([filter, ]listener)`
* `filter` Object - (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
* `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
* `details` Object
@ -68,8 +68,8 @@ The `callback` has to be called with an `response` object.
#### `webRequest.onBeforeSendHeaders([filter, ]listener)`
* `filter` Object - (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
* `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
@ -95,8 +95,8 @@ The `callback` has to be called with an `response` object.
#### `webRequest.onSendHeaders([filter, ]listener)`
* `filter` Object - (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
* `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
* `details` Object
@ -114,8 +114,8 @@ response are visible by the time this listener is fired.
#### `webRequest.onHeadersReceived([filter, ]listener)`
* `filter` Object - (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
* `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
@ -145,8 +145,8 @@ The `callback` has to be called with an `response` object.
#### `webRequest.onResponseStarted([filter, ]listener)`
* `filter` Object - (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
* `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
* `details` Object
@ -168,8 +168,8 @@ and response headers are available.
#### `webRequest.onBeforeRedirect([filter, ]listener)`
* `filter` Object - (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
* `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
* `details` Object
@ -191,8 +191,8 @@ redirect is about to occur.
#### `webRequest.onCompleted([filter, ]listener)`
* `filter` Object - (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
* `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
* `details` Object
@ -212,8 +212,8 @@ completed.
#### `webRequest.onErrorOccurred([filter, ]listener)`
* `filter` Object - (optional)
* `urls` String[] - Array of URL patterns that will be used to filter out the
* `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
* `details` Object