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

Cleanup docs and standardize structs

Browse source
This commit is contained in:
Samuel Attard 2016-10-13 14:38:06 +11:00
parent 46cd8708a4
commit 78343a62b8
No known key found for this signature in database
GPG key ID: 273DC1869D8F13EF
5 changed files with 24 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/api/session.md
View file

@ -402,7 +402,7 @@ The following events are available on instances of `Cookies`:
#### Event: 'changed'
* `event` Event
* `cookie` Object - The cookie that was changed
* `cookie` [Cookie](structures/cookie.md) - The cookie that was changed
* `cause` String - The cause of the change with one of the following values:
* `explicit` - The cookie was changed directly by a consumer's action.
* `overwrite` - The cookie was automatically removed due to an insert
@ -436,21 +436,7 @@ The following methods are available on instances of `Cookies`:
Sends a request to get all cookies matching `details`, `callback` will be called
with `callback(error, cookies)` on complete.
`cookies` is an Array of `cookie` objects.
* `cookie` Object
* `name` String - The name of the cookie.
* `value` String - The value of the cookie.
* `domain` String - The domain of the cookie.
* `hostOnly` String - Whether the cookie is a host-only cookie.
* `path` String - The path of the cookie.
* `secure` Boolean - Whether the cookie is marked as secure.
* `httpOnly` Boolean - Whether the cookie is marked as HTTP only.
* `session` Boolean - Whether the cookie is a session cookie or a persistent
cookie with an expiration date.
* `expirationDate` Double (optional) - The expiration date of the cookie as
the number of seconds since the UNIX epoch. Not provided for session
cookies.
`cookies` is an Array of [`cookie`](structures/cookie.md) objects.
#### `cookies.set(details, callback)`