socketioMEANseed/server/node_modules/fresh/README.md
server/node_modules/fresh/README.mdRaw
1# fresh
2
3[![NPM Version][npm-image]][npm-url]
4[![NPM Downloads][downloads-image]][downloads-url]
5[![Node.js Version][node-version-image]][node-version-url]
6[![Build Status][travis-image]][travis-url]
7[![Test Coverage][coveralls-image]][coveralls-url]
8
9HTTP response freshness testing
10
11## Installation
12
13```
14$ npm install fresh
15```
16
17## API
18
19```js
20var fresh = require('fresh')
21```
22
23### fresh(req, res)
24
25 Check freshness of `req` and `res` headers.
26
27 When the cache is "fresh" __true__ is returned,
28 otherwise __false__ is returned to indicate that
29 the cache is now stale.
30
31## Example
32
33```js
34var req = { 'if-none-match': 'tobi' };
35var res = { 'etag': 'luna' };
36fresh(req, res);
37// => false
38
39var req = { 'if-none-match': 'tobi' };
40var res = { 'etag': 'tobi' };
41fresh(req, res);
42// => true
43```
44
45## License
46
47[MIT](LICENSE)
48
49[npm-image]: https://img.shields.io/npm/v/fresh.svg?style=flat
50[npm-url]: https://npmjs.org/package/fresh
51[node-version-image]: https://img.shields.io/badge/node.js-%3E%3D_0.6-brightgreen.svg?style=flat
52[node-version-url]: http://nodejs.org/download/
53[travis-image]: https://img.shields.io/travis/jshttp/fresh.svg?style=flat
54[travis-url]: https://travis-ci.org/jshttp/fresh
55[coveralls-image]: https://img.shields.io/coveralls/jshttp/fresh.svg?style=flat
56[coveralls-url]: https://coveralls.io/r/jshttp/fresh?branch=master
57[downloads-image]: https://img.shields.io/npm/dm/fresh.svg?style=flat
58[downloads-url]: https://npmjs.org/package/fresh