{"_id":"faq","_rev":"3-7e2ec5e5274fe703b74e3af358b96b69","name":"faq","description":"a faq middleware for express.","dist-tags":{"latest":"0.0.1"},"versions":{"0.0.1":{"name":"faq","version":"0.0.1","description":"a faq middleware for express.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/JamesYYang/faq.git"},"keywords":["express","faq"],"author":{"name":"James.Y.Yang"},"license":"MIT","bugs":{"url":"https://github.com/JamesYYang/faq/issues"},"homepage":"https://github.com/JamesYYang/faq#readme","devDependencies":{"express":"^4.13.3"},"dependencies":{"accepts":"^1.2.12"},"gitHead":"af0f6fdb79898a46ba1ee587940c72e98bf67356","_id":"faq@0.0.1","_shasum":"feaefa314b2d1078ef2e27a54798fffd37dab408","_from":"faq","_resolved":"file:faq","_npmVersion":"2.11.3","_nodeVersion":"0.12.7","_npmUser":{"name":"james.y.yang","email":"james.yang516@gmail.com"},"maintainers":[{"name":"james.y.yang","email":"james.yang516@gmail.com"}],"dist":{"shasum":"feaefa314b2d1078ef2e27a54798fffd37dab408","tarball":"https://registry.npmjs.org/faq/-/faq-0.0.1.tgz","integrity":"sha512-5sPK40Tw9pZ4veK8w8e31qE3FZkJqjZfRrXOpvI/j0F0p6Ikv/gKNn/Z7rddoHwtEHVddYZ+F+ChrwR0h5l9xQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIEwZ5MnPqRqRn5VOQrAWVgmFgDXOlwD1mbZfNmjZL/A6AiBxS4e7VtfUpvPYBSoe4jMhcmc2VaG+eZdXmMgJOOC52w=="}]}}},"readme":"# faq\r\n\r\nfaq middleware for express\r\n\r\n## Install\r\n\r\n```sh\r\n$ npm install faq\r\n```\r\n\r\n## API\r\n\r\n```js\r\nvar faq = require('faq')\r\n```\r\n\r\n### faq(options)\r\n\r\nUsing this middleware to handle load balance server's faq monitor.\r\n\r\n#### Options\r\n\r\nFaq accepts these properties in the options object.\r\n\r\n##### uri\r\n\r\nProvide faq URI. Default URI is ```/faq```.\r\n\r\n##### body\r\n\r\nProvide faq response object. Default response is ```ok```.\r\n\r\n## Examples\r\n\r\n### Simple example\r\n\r\nBasic example of adding this middleware.\r\n\r\n```js\r\nvar app = require(\"express\")();\r\nvar faq = require(\"faq\");\r\n\r\napp.use(faq());\r\n\r\n```\r\n\r\n### Custom URI and Response\r\n\r\n\r\n```js\r\nvar app = require(\"express\")();\r\nvar faq = require(\"faq\");\r\n\r\nvar body = {\r\n  content: \"hello faq\"\r\n}\r\n\r\nvar faqOption = {\r\n  uri: \"/new-faq\",\r\n  body: body\r\n}\r\n\r\napp.use(faq(faqOption));\r\n\r\n```\r\n\r\n## License\r\n\r\n[MIT]","maintainers":[{"name":"james.y.yang","email":"james.yang516@gmail.com"}],"time":{"modified":"2022-06-17T23:32:40.611Z","created":"2015-08-15T09:01:53.456Z","0.0.1":"2015-08-15T09:01:53.456Z"},"homepage":"https://github.com/JamesYYang/faq#readme","keywords":["express","faq"],"repository":{"type":"git","url":"git+https://github.com/JamesYYang/faq.git"},"author":{"name":"James.Y.Yang"},"bugs":{"url":"https://github.com/JamesYYang/faq/issues"},"license":"MIT","readmeFilename":"README.md"}