-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
52 lines (52 loc) · 4.58 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
"name": "serve-favicon",
"description": "favicon serving middleware with caching",
"version": "2.2.0",
"author": {
"name": "Douglas Christopher Wilson",
"email": "doug@somethingdoug.com"
},
"license": "MIT",
"keywords": [
"express",
"favicon",
"middleware"
],
"repository": {
"type": "git",
"url": "expressjs/serve-favicon"
},
"dependencies": {
"etag": "~1.5.1",
"fresh": "0.2.4",
"ms": "0.7.0",
"parseurl": "~1.3.0"
},
"devDependencies": {
"istanbul": "0.3.5",
"mocha": "~2.0.1",
"proxyquire": "~1.2.0",
"supertest": "~0.15.0"
},
"files": [
"LICENSE",
"HISTORY.md",
"index.js"
],
"engines": {
"node": ">= 0.8.0"
},
"scripts": {
"test": "mocha --reporter spec --bail --check-leaks test/",
"test-cov": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter dot --check-leaks test/",
"test-travis": "istanbul cover node_modules/mocha/bin/_mocha --report lcovonly -- --reporter spec --check-leaks test/"
},
"readme": "# serve-favicon\n\n[![NPM Version][npm-image]][npm-url]\n[![NPM Downloads][downloads-image]][downloads-url]\n[![Build Status][travis-image]][travis-url]\n[![Test Coverage][coveralls-image]][coveralls-url]\n[![Gittip][gittip-image]][gittip-url]\n\nNode.js middleware for serving a favicon.\n\nWhy use this module?\n\n - User agents request `favicon.ico` frequently and indiscriminately, so you\n may wish to exclude these requests from your logs by using this middleware\n before your logger middleware.\n - This module caches the icon in memory to improve performance by skipping\n disk access.\n - This module provides an `ETag` based on the contents of the icon, rather\n than file system properties.\n - This module will serve with the most compatible `Content-Type`.\n\n## Install\n\n```bash\nnpm install serve-favicon\n```\n\n## API\n\n### favicon(path, options)\n\nCreate new middleware to serve a favicon from the given `path` to a favicon file.\n`path` may also be a `Buffer` of the icon to serve.\n\n#### Options\n\nServe favicon accepts these properties in the options object.\n\n##### maxAge\n\nThe `cache-control` `max-age` directive in `ms`, defaulting to 1 day. This can\nalso be a string accepted by the [ms](https://www.npmjs.org/package/ms#readme)\nmodule.\n\n## Examples\n\nTypically this middleware will come very early in your stack (maybe even first)\nto avoid processing any other middleware if we already know the request is for\n`/favicon.ico`.\n\n### express\n\n```javascript\nvar express = require('express');\nvar favicon = require('serve-favicon');\n\nvar app = express();\napp.use(favicon(__dirname + '/public/favicon.ico'));\n\n// Add your routes here, etc.\n\napp.listen(3000);\n```\n\n### connect\n\n```javascript\nvar connect = require('connect');\nvar favicon = require('serve-favicon');\n\nvar app = connect();\napp.use(favicon(__dirname + '/public/favicon.ico'));\n\n// Add your middleware here, etc.\n\napp.listen(3000);\n```\n\n### vanilla http server\n\nThis middleware can be used anywhere, even outside express/connect. It takes\n`req`, `res`, and `callback`.\n\n```javascript\nvar http = require('http');\nvar favicon = require('serve-favicon');\nvar finalhandler = require('finalhandler');\n\nvar _favicon = favicon(__dirname + '/public/favicon.ico');\n\nvar server = http.createServer(function onRequest(req, res) {\n var done = finalhandler(req, res);\n\n _favicon(req, res, function onNext(err) {\n if (err) return done(err);\n\n // continue to process the request here, etc.\n\n res.statusCode = 404;\n res.end('oops');\n });\n});\n\nserver.listen(3000);\n```\n\n## License\n\n[MIT](LICENSE)\n\n[npm-image]: https://img.shields.io/npm/v/serve-favicon.svg?style=flat\n[npm-url]: https://npmjs.org/package/serve-favicon\n[travis-image]: https://img.shields.io/travis/expressjs/serve-favicon.svg?style=flat\n[travis-url]: https://travis-ci.org/expressjs/serve-favicon\n[coveralls-image]: https://img.shields.io/coveralls/expressjs/serve-favicon.svg?style=flat\n[coveralls-url]: https://coveralls.io/r/expressjs/serve-favicon?branch=master\n[downloads-image]: https://img.shields.io/npm/dm/serve-favicon.svg?style=flat\n[downloads-url]: https://npmjs.org/package/serve-favicon\n[gittip-image]: https://img.shields.io/gittip/dougwilson.svg?style=flat\n[gittip-url]: https://www.gittip.com/dougwilson/\n",
"readmeFilename": "README.md",
"_id": "serve-favicon@2.2.0",
"dist": {
"shasum": "19271683fadf5057a965e54778250f36a99ade05"
},
"_from": "serve-favicon@~2.2.0",
"_resolved": "https://registry.npmjs.org/serve-favicon/-/serve-favicon-2.2.0.tgz"
}