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

docs: Use "(optional)" instead of "__optional__"

Browse source
This commit is contained in:
Cheng Zhao 2015-12-18 11:07:32 +08:00
parent d7946b9c41
commit d5168f09d6
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
docs/api/session.md
View file

@ -102,14 +102,14 @@ session.defaultSession.cookies.set(cookie, function(error) {
#### `ses.cookies.get(filter, callback)` #### `ses.cookies.get(filter, callback)`
* `filter` Object * `filter` Object
* `url` String __optional__ - Retrieves cookies which are associated with * `url` String (optional) - Retrieves cookies which are associated with
`url`. Empty implies retrieving cookies of all urls. `url`. Empty implies retrieving cookies of all urls.
* `name` String __optional__ - Filters cookies by name. * `name` String (optional) - Filters cookies by name.
* `domain` String __optional__ - Retrieves cookies whose domains match or are * `domain` String (optional) - Retrieves cookies whose domains match or are
subdomains of `domains` subdomains of `domains`
* `path` String __optional__ - Retrieves cookies whose path matches `path`. * `path` String (optional) - Retrieves cookies whose path matches `path`.
* `secure` Boolean __optional__ - Filters cookies by their Secure property. * `secure` Boolean (optional) - Filters cookies by their Secure property.
* `session` Boolean __optional__ - Filters out session or persistent cookies. * `session` Boolean (optional) - Filters out session or persistent cookies.
* `callback` Function * `callback` Function
Sends a request to get all cookies matching `details`, `callback` will be called Sends a request to get all cookies matching `details`, `callback` will be called
@ -127,7 +127,7 @@ with `callback(error, cookies)` on complete.
* `httpOnly` Boolean - Whether the cookie is marked as HTTP only. * `httpOnly` Boolean - Whether the cookie is marked as HTTP only.
* `session` Boolean - Whether the cookie is a session cookie or a persistent * `session` Boolean - Whether the cookie is a session cookie or a persistent
cookie with an expiration date. cookie with an expiration date.
* `expirationDate` Double __optional__ - The expiration date of the cookie as * `expirationDate` Double (optional) - The expiration date of the cookie as
the number of seconds since the UNIX epoch. Not provided for session the number of seconds since the UNIX epoch. Not provided for session
cookies. cookies.
@ -327,8 +327,8 @@ is about to occur.
The `callback` has to be called with an `response` object: The `callback` has to be called with an `response` object:
* `response` Object * `response` Object
* `cancel` Boolean __optional__ * `cancel` Boolean (optional)
* `redirectURL` String __optional__ - The original request is prevented from * `redirectURL` String (optional) - The original request is prevented from
being sent or completed, and is instead redirected to the given URL. being sent or completed, and is instead redirected to the given URL.
#### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)` #### `ses.webRequest.onBeforeSendHeaders([filter, ]listener)`
@ -351,8 +351,8 @@ TCP connection is made to the server, but before any http data is sent.
The `callback` has to be called with an `response` object: The `callback` has to be called with an `response` object:
* `response` Object * `response` Object
* `cancel` Boolean __optional__ * `cancel` Boolean (optional)
* `requestHeaders` Object __optional__ - When provided, request will be made * `requestHeaders` Object (optional) - When provided, request will be made
with these headers. with these headers.
#### `ses.webRequest.onSendHeaders([filter, ]listener)` #### `ses.webRequest.onSendHeaders([filter, ]listener)`
@ -394,7 +394,7 @@ The `callback` has to be called with an `response` object:
* `response` Object * `response` Object
* `cancel` Boolean * `cancel` Boolean
* `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.
#### `ses.webRequest.onResponseStarted([filter, ]listener)` #### `ses.webRequest.onResponseStarted([filter, ]listener)`
@ -434,7 +434,7 @@ redirect is about to occur.
* `timestamp` Double * `timestamp` Double
* `redirectURL` String * `redirectURL` String
* `statusCode` Integer * `statusCode` Integer
* `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` Object