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

Merge pull request #5688 from enlight/patch-1

Browse source 
Improve documentation of `ses.cookies.set()`
This commit is contained in:
Cheng Zhao 2016-05-25 10:44:33 +00:00
commit b86ded3b54
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/api/session.md
View file

@ -137,20 +137,21 @@ with `callback(error, cookies)` on complete.
#### `ses.cookies.set(details, callback)` #### `ses.cookies.set(details, callback)`
* `details` Object * `details` Object
* `url` String - Retrieves cookies which are associated with `url` * `url` String - The url to associate the cookie with.
* `name` String - The name of the cookie. Empty by default if omitted. * `name` String - The name of the cookie. Empty by default if omitted.
* `value` String - The value of the cookie. Empty by default if omitted. * `value` String - The value of the cookie. Empty by default if omitted.
* `domain` String - The domain of the cookie. Empty by default if omitted. * `domain` String - The domain of the cookie. Empty by default if omitted.
* `path` String - The path of the cookie. Empty by default if omitted. * `path` String - The path of the cookie. Empty by default if omitted.
* `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to * `secure` Boolean - Whether the cookie should be marked as Secure. Defaults to
false. false.
* `session` Boolean - Whether the cookie should be marked as HttpOnly. Defaults * `session` Boolean - Whether the cookie should be marked as HTTP only. Defaults
to false. to false.
* `expirationDate` Double - The expiration date of the cookie as the number of * `expirationDate` Double - The expiration date of the cookie as the number of
seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. seconds since the UNIX epoch. If omitted then the cookie becomes a session
cookie and will not be retained between sessions.
* `callback` Function * `callback` Function
Sets the cookie with `details`, `callback` will be called with `callback(error)` Sets a cookie with `details`, `callback` will be called with `callback(error)`
on complete. on complete.
#### `ses.cookies.remove(url, name, callback)` #### `ses.cookies.remove(url, name, callback)`