dgbuilder/dgeflows/node_modules/cookie-parser/README.md

   1 # cookie-parser
   2
   3 [![NPM Version][npm-image]][npm-url]
   4 [![NPM Downloads][downloads-image]][downloads-url]
   5 [![Build Status][travis-image]][travis-url]
   6 [![Test Coverage][coveralls-image]][coveralls-url]
   7
   8 Parse `Cookie` header and populate `req.cookies` with an object keyed by the cookie
   9 names. Optionally you may enable signed cookie support by passing a `secret` string,
  10 which assigns `req.secret` so it may be used by other middleware.
  11
  12 ## Installation
  13
  14 ```sh
  15 $ npm install cookie-parser
  16 ```
  17
  18 ## API
  19
  20 ```js
  21 var express      = require('express')
  22 var cookieParser = require('cookie-parser')
  23
  24 var app = express()
  25 app.use(cookieParser())
  26 ```
  27
  28 ### cookieParser(secret, options)
  29
  30 - `secret` a string used for signing cookies. This is optional and if not specified, will not parse signed cookies.
  31 - `options` an object that is passed to `cookie.parse` as the second option. See [cookie](https://www.npmjs.org/package/cookie) for more information.
  32   - `decode` a function to decode the value of the cookie
  33
  34 ### cookieParser.JSONCookie(str)
  35
  36 Parse a cookie value as a JSON cookie. This will return the parsed JSON value if it was a JSON cookie, otherwise it will return the passed value.
  37
  38 ### cookieParser.JSONCookies(cookies)
  39
  40 Given an object, this will iterate over the keys and call `JSONCookie` on each value. This will return the same object passed in.
  41
  42 ### cookieParser.signedCookie(str, secret)
  43
  44 Parse a cookie value as a signed cookie. This will return the parsed unsigned value if it was a signed cookie and the signature was valid, otherwise it will return the passed value.
  45
  46 ### cookieParser.signedCookies(cookies, secret)
  47
  48 Given an object, this will iterate over the keys and check if any value is a signed cookie. If it is a signed cookie and the signature is valid, the key will be deleted from the object and added to the new object that is returned.
  49
  50 ## Example
  51
  52 ```js
  53 var express      = require('express')
  54 var cookieParser = require('cookie-parser')
  55
  56 var app = express()
  57 app.use(cookieParser())
  58
  59 app.get('/', function(req, res) {
  60   console.log("Cookies: ", req.cookies)
  61 })
  62
  63 app.listen(8080)
  64
  65 // curl command that sends an HTTP request with two cookies
  66 // curl http://127.0.0.1:8080 --cookie "Cho=Kim;Greet=Hello"
  67 ```
  68
  69 ### [MIT Licensed](LICENSE)
  70
  71 [npm-image]: https://img.shields.io/npm/v/cookie-parser.svg
  72 [npm-url]: https://npmjs.org/package/cookie-parser
  73 [travis-image]: https://img.shields.io/travis/expressjs/cookie-parser/master.svg
  74 [travis-url]: https://travis-ci.org/expressjs/cookie-parser
  75 [coveralls-image]: https://img.shields.io/coveralls/expressjs/cookie-parser/master.svg
  76 [coveralls-url]: https://coveralls.io/r/expressjs/cookie-parser?branch=master
  77 [downloads-image]: https://img.shields.io/npm/dm/cookie-parser.svg
  78 [downloads-url]: https://npmjs.org/package/cookie-parser