Skip to content
This repository has been archived by the owner on Sep 14, 2022. It is now read-only.

Commit

Permalink
docs: document cookie options in readme
Browse files Browse the repository at this point in the history
closes #178
  • Loading branch information
IvanM authored and dougwilson committed Apr 22, 2019
1 parent e30be37 commit 7193505
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Expand Up @@ -68,8 +68,16 @@ following keys:
- `key` - the name of the cookie to use to store the token secret
(defaults to `'_csrf'`).
- `path` - the path of the cookie (defaults to `'/'`).
- any other [res.cookie](http://expressjs.com/4x/api.html#res.cookie)
option can be set.
- `signed` - indicates if the cookie should be signed (defaults to `false`).
- `secure` - marks the cookie to be used with HTTPS only (defaults to
`false`).
- `maxAge` - the number of seconds after which the cookie will expire
(defaults to session length).
- `httpOnly` - flags the cookie to be accessible only by the web server
(defaults to `false`).
- `sameSite` - sets the same site policy for the cookie (defaults to none).
- `domain` - sets the domain the cookie is valid on (defaults to current
domain).

##### ignoreMethods

Expand Down

0 comments on commit 7193505

Please sign in to comment.