65 lines
1.8 KiB
Markdown
65 lines
1.8 KiB
Markdown
# cookie
|
|
|
|
[![NPM Version][npm-image]][npm-url]
|
|
[![NPM Downloads][downloads-image]][downloads-url]
|
|
[![Node.js Version][node-version-image]][node-version-url]
|
|
[![Build Status][travis-image]][travis-url]
|
|
[![Test Coverage][coveralls-image]][coveralls-url]
|
|
|
|
cookie is a basic cookie parser and serializer. It doesn't make assumptions about how you are going to deal with your cookies. It basically just provides a way to read and write the HTTP cookie headers.
|
|
|
|
See [RFC6265](http://tools.ietf.org/html/rfc6265) for details about the http header for cookies.
|
|
|
|
## how?
|
|
|
|
```
|
|
npm install cookie
|
|
```
|
|
|
|
```javascript
|
|
var cookie = require('cookie');
|
|
|
|
var hdr = cookie.serialize('foo', 'bar');
|
|
// hdr = 'foo=bar';
|
|
|
|
var cookies = cookie.parse('foo=bar; cat=meow; dog=ruff');
|
|
// cookies = { foo: 'bar', cat: 'meow', dog: 'ruff' };
|
|
```
|
|
|
|
## more
|
|
|
|
The serialize function takes a third parameter, an object, to set cookie options. See the RFC for valid values.
|
|
|
|
### path
|
|
> cookie path
|
|
|
|
### expires
|
|
> absolute expiration date for the cookie (Date object)
|
|
|
|
### maxAge
|
|
> relative max age of the cookie from when the client receives it (seconds)
|
|
|
|
### domain
|
|
> domain for the cookie
|
|
|
|
### secure
|
|
> true or false
|
|
|
|
### httpOnly
|
|
> true or false
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|
|
|
|
[npm-image]: https://img.shields.io/npm/v/cookie.svg
|
|
[npm-url]: https://npmjs.org/package/cookie
|
|
[node-version-image]: https://img.shields.io/node/v/cookie.svg
|
|
[node-version-url]: http://nodejs.org/download/
|
|
[travis-image]: https://img.shields.io/travis/jshttp/cookie/master.svg
|
|
[travis-url]: https://travis-ci.org/jshttp/cookie
|
|
[coveralls-image]: https://img.shields.io/coveralls/jshttp/cookie/master.svg
|
|
[coveralls-url]: https://coveralls.io/r/jshttp/cookie?branch=master
|
|
[downloads-image]: https://img.shields.io/npm/dm/cookie.svg
|
|
[downloads-url]: https://npmjs.org/package/cookie
|