UNPKG

motion

Version:

motion - moving development forward

73 lines (72 loc) 5.62 kB
{ "_args": [ [ "finalhandler@https://registry.npmjs.org/finalhandler/-/finalhandler-0.3.4.tgz", "/Users/nw/flint/packages/flint" ] ], "_from": "finalhandler@0.3.4", "_id": "finalhandler@0.3.4", "_inCache": true, "_location": "/finalhandler", "_phantomChildren": {}, "_requested": { "name": "finalhandler", "raw": "finalhandler@https://registry.npmjs.org/finalhandler/-/finalhandler-0.3.4.tgz", "rawSpec": "https://registry.npmjs.org/finalhandler/-/finalhandler-0.3.4.tgz", "scope": null, "spec": "https://registry.npmjs.org/finalhandler/-/finalhandler-0.3.4.tgz", "type": "remote" }, "_requiredBy": [ "/express" ], "_resolved": "https://registry.npmjs.org/finalhandler/-/finalhandler-0.3.4.tgz", "_shasum": "4787d3573d079ae8b07536f26b0b911ebaf2a2ac", "_shrinkwrap": null, "_spec": "finalhandler@https://registry.npmjs.org/finalhandler/-/finalhandler-0.3.4.tgz", "_where": "/Users/nw/flint/packages/flint", "author": { "email": "doug@somethingdoug.com", "name": "Douglas Christopher Wilson" }, "bugs": { "url": "https://github.com/pillarjs/finalhandler/issues" }, "dependencies": { "debug": "~2.1.3", "escape-html": "1.0.1", "on-finished": "~2.2.0" }, "description": "Node.js final http responder", "devDependencies": { "istanbul": "0.3.8", "mocha": "~2.2.1", "readable-stream": "~1.0.33", "supertest": "~0.15.0" }, "engines": { "node": ">= 0.8" }, "files": [ "HISTORY.md", "LICENSE", "index.js" ], "homepage": "https://github.com/pillarjs/finalhandler#readme", "license": "MIT", "name": "finalhandler", "optionalDependencies": {}, "readme": "# finalhandler\n\n[![NPM Version][npm-image]][npm-url]\n[![NPM Downloads][downloads-image]][downloads-url]\n[![Node.js Version][node-image]][node-url]\n[![Build Status][travis-image]][travis-url]\n[![Test Coverage][coveralls-image]][coveralls-url]\n\nNode.js function to invoke as the final step to respond to HTTP request.\n\n## Installation\n\n```sh\n$ npm install finalhandler\n```\n\n## API\n\n```js\nvar finalhandler = require('finalhandler')\n```\n\n### finalhandler(req, res, [options])\n\nReturns function to be invoked as the final step for the given `req` and `res`.\nThis function is to be invoked as `fn(err)`. If `err` is falsy, the handler will\nwrite out a 404 response to the `res`. If it is truthy, an error response will\nbe written out to the `res`, and `res.statusCode` is set from `err.status`.\n\nThe final handler will also unpipe anything from `req` when it is invoked.\n\n#### options.env\n\nBy default, the environment is determined by `NODE_ENV` variable, but it can be\noverridden by this option.\n\n#### options.onerror\n\nProvide a function to be called with the `err` when it exists. Can be used for\nwriting errors to a central location without excessive function generation. Called\nas `onerror(err, req, res)`.\n\n## Examples\n\n### always 404\n\n```js\nvar finalhandler = require('finalhandler')\nvar http = require('http')\n\nvar server = http.createServer(function (req, res) {\n var done = finalhandler(req, res)\n done()\n})\n\nserver.listen(3000)\n```\n\n### perform simple action\n\n```js\nvar finalhandler = require('finalhandler')\nvar fs = require('fs')\nvar http = require('http')\n\nvar server = http.createServer(function (req, res) {\n var done = finalhandler(req, res)\n\n fs.readFile('index.html', function (err, buf) {\n if (err) return done(err)\n res.setHeader('Content-Type', 'text/html')\n res.end(buf)\n })\n})\n\nserver.listen(3000)\n```\n\n### use with middleware-style functions\n\n```js\nvar finalhandler = require('finalhandler')\nvar http = require('http')\nvar serveStatic = require('serve-static')\n\nvar serve = serveStatic('public')\n\nvar server = http.createServer(function (req, res) {\n var done = finalhandler(req, res)\n serve(req, res, done)\n})\n\nserver.listen(3000)\n```\n\n### keep log of all errors\n\n```js\nvar finalhandler = require('finalhandler')\nvar fs = require('fs')\nvar http = require('http')\n\nvar server = http.createServer(function (req, res) {\n var done = finalhandler(req, res, {onerror: logerror})\n\n fs.readFile('index.html', function (err, buf) {\n if (err) return done(err)\n res.setHeader('Content-Type', 'text/html')\n res.end(buf)\n })\n})\n\nserver.listen(3000)\n\nfunction logerror(err) {\n console.error(err.stack || err.toString())\n}\n```\n\n## License\n\n[MIT](LICENSE)\n\n[npm-image]: https://img.shields.io/npm/v/finalhandler.svg\n[npm-url]: https://npmjs.org/package/finalhandler\n[node-image]: https://img.shields.io/node/v/finalhandler.svg\n[node-url]: http://nodejs.org/download/\n[travis-image]: https://img.shields.io/travis/pillarjs/finalhandler.svg\n[travis-url]: https://travis-ci.org/pillarjs/finalhandler\n[coveralls-image]: https://img.shields.io/coveralls/pillarjs/finalhandler.svg\n[coveralls-url]: https://coveralls.io/r/pillarjs/finalhandler?branch=master\n[downloads-image]: https://img.shields.io/npm/dm/finalhandler.svg\n[downloads-url]: https://npmjs.org/package/finalhandler\n", "readmeFilename": "README.md", "repository": { "type": "git", "url": "git+https://github.com/pillarjs/finalhandler.git" }, "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/" }, "version": "0.3.4" }