{"_id":"qpp-shared-healthcheck-node","_rev":"194-6c21ad42b0ba95a4cf25c7dc4248ff79","name":"qpp-shared-healthcheck-node","dist-tags":{"latest":"0.3.1"},"versions":{"0.1.1":{"name":"qpp-shared-healthcheck-node","version":"0.1.1","author":"","license":"UNLICENSED","_id":"qpp-shared-healthcheck-node@0.1.1","maintainers":[{"name":"cmsgov","email":"hello@navahq.com"}],"dist":{"shasum":"2a7c77adbaa54a21dcfc493edca139dcefcdc8fe","tarball":"https://registry.npmjs.org/qpp-shared-healthcheck-node/-/qpp-shared-healthcheck-node-0.1.1.tgz","integrity":"sha512-1T6OSirWDCVpFM9IG8DkPC7SOkgzjiui1Qp0BOQ4xdUz5uFyNnyZmBIUkk+98HLyvpPFZA3IwdvICnrYN9hWuQ==","signatures":[{"sig":"MEUCIQCq0EYxmn2SyFy8lM2x+lEDTKndeCN4XKrIJ2wnO5JywgIgatjYz2sQkOhz4KkdewnOYEUkcFeJtTa62U0G9TWenLQ=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"index.js","gitHead":"05db0e693170852327351a9939c15c19b33ebf7e","scripts":{"test":"mocha ./test/index.js"},"_npmUser":{"name":"cmsgov","email":"hello@navahq.com"},"repository":{"url":"https://github.cms.gov/qpp/qpp-shared-healthcheck-node.git","type":"git"},"_npmVersion":"5.5.1","description":"health check endpoint for QPP APIs","directories":{},"_nodeVersion":"8.6.0","dependencies":{"express":"^4.16.2"},"devDependencies":{"mocha":"^4.0.1","supertest":"^3.0.0"},"_npmOperationalInternal":{"tmp":"tmp/qpp-shared-healthcheck-node-0.1.1.tgz_1511801252153_0.527794242138043","host":"s3://npm-registry-packages"}},"0.1.2":{"name":"qpp-shared-healthcheck-node","version":"0.1.2","author":"","license":"UNLICENSED","_id":"qpp-shared-healthcheck-node@0.1.2","maintainers":[{"name":"cmsgov","email":"hello@navahq.com"}],"dist":{"shasum":"6e24f3eb377757f5fe5a1b43120b9879e3cc712a","tarball":"https://registry.npmjs.org/qpp-shared-healthcheck-node/-/qpp-shared-healthcheck-node-0.1.2.tgz","integrity":"sha512-avog3DaUc1TL5U9oeYk8Kb2DdyePDpQK+Jo/KIt2JtCg1RQk12cTuhWvLnb7bUoQDrBTilEpaI7mR3LoJ4R8aA==","signatures":[{"sig":"MEQCIBxi1d3XokeyhDxRiv9FpmolB3wADq/u2PK3AQTb1+YmAiAh9tdPbB7SJxzH6XGi5BbTa1bKiorlntOceu1Ig3tREw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"index.js","gitHead":"f6af9c7072876751bcceda9f6f3d8241b0dfa233","scripts":{"test":"mocha ./test/index.js"},"_npmUser":{"name":"cmsgov","email":"hello@navahq.com"},"repository":{"url":"https://github.cms.gov/qpp/qpp-shared-healthcheck-node.git","type":"git"},"_npmVersion":"5.5.1","description":"health check endpoint for QPP APIs","directories":{},"_nodeVersion":"8.6.0","devDependencies":{"mocha":"^4.0.1","express":"^4.0.0","supertest":"^3.0.0"},"peerDependencies":{"express":"^4.0.0"},"_npmOperationalInternal":{"tmp":"tmp/qpp-shared-healthcheck-node-0.1.2.tgz_1511812283373_0.8310158755630255","host":"s3://npm-registry-packages"}},"0.2.0":{"name":"qpp-shared-healthcheck-node","version":"0.2.0","author":"","license":"UNLICENSED","_id":"qpp-shared-healthcheck-node@0.2.0","maintainers":[{"name":"cmsgov","email":"hello@navahq.com"}],"dist":{"shasum":"418c9dc98ae69fb81991beaa5ec6f2dbeb79503c","tarball":"https://registry.npmjs.org/qpp-shared-healthcheck-node/-/qpp-shared-healthcheck-node-0.2.0.tgz","fileCount":5,"integrity":"sha512-/cNyrnvkc0JMitBodTQ9yWrV6h/3ex1rBhABkZnJQ/srrZ5FNlwukhKorcEMb3pLps/SYmsChyP3YU1xnSSlVg==","signatures":[{"sig":"MEUCIQDS27g6CPnR4As4URnHi0Ob3vz+N4oKrYlsXJvaUoDsOgIgIXj3+6L89KP67XD/5VdCU7ZV7Qwm3je9bjb5lMGXwSE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":21853},"main":"index.js","gitHead":"efc26ae392d9a55dc2b8e43f1afcefa5eeb9f56e","scripts":{"test":"mocha ./test/index.js"},"_npmUser":{"name":"cmsgov","email":"hello@navahq.com"},"repository":{"url":"https://github.cms.gov/qpp/qpp-shared-healthcheck-node.git","type":"git"},"_npmVersion":"5.6.0","description":"health check endpoint for QPP APIs","directories":{},"_nodeVersion":"9.9.0","_hasShrinkwrap":false,"devDependencies":{"mocha":"^4.0.1","express":"^4.0.0","supertest":"^3.0.0"},"peerDependencies":{"express":"^4.0.0"},"_npmOperationalInternal":{"tmp":"tmp/qpp-shared-healthcheck-node_0.2.0_1523311014444_0.1997513933370587","host":"s3://npm-registry-packages"}},"0.3.0":{"name":"qpp-shared-healthcheck-node","version":"0.3.0","author":"","license":"UNLICENSED","_id":"qpp-shared-healthcheck-node@0.3.0","maintainers":[{"name":"cmsgov","email":"hello@navahq.com"}],"dist":{"shasum":"27c9c9eca3edfda415008489c79221932acf364f","tarball":"https://registry.npmjs.org/qpp-shared-healthcheck-node/-/qpp-shared-healthcheck-node-0.3.0.tgz","fileCount":5,"integrity":"sha512-E++7rk+rcKVtQunaDyWywu0l/HfdrJIqmKhHJ3n43GHoN42s6HuCapV9QgZl6IfLBv1MRXfZPraIrRMD1gXYvg==","signatures":[{"sig":"MEYCIQC4fM3yRAD4lDIIJh0MWgZBt289DxdUT+HEjWV2J0+EbgIhAJ514V5WH8LRGg5OQ2o62uq17fFWazNw5cszU7gBms+S","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":24616,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJb7vMzCRA9TVsSAnZWagAAC5wP/ji8Ey4MMmbQdmV5wY+c\ns6ADTgChOWuGl0nUnaS6UHGsV4UYpPKuhJaQ4MScCQ0zK+lPI5ja8XOsE8eI\nmbXIVADjZmcJSHgOyU3ZcYj/x1VP4CdqnHzYi/kEFgZ6dZmGh/cVFcxVn4Tp\nDYx3PNYmkVbuuBLHTIgl6EX1lfJxv1OeYGWHAMkNYN34V2PS5mgPm2nxPEA5\nQuAGpCkscrvQIv/WbV3serTdJ2Iq7/HQfaVwE0xB+1u5MtSFXqHRhrH7Wwh0\nm0O63pSZEx2+OgbQNPJRU1JQJZqeCRm8JTyr5ir257DZ0d37wAIzRz9iCtob\nBZ8//X/cj4wPBK06113t7CXqksBQW5wcv+uFIvDf1gAEsrrtucnB9SX4qwh9\naBLe+o6PXhVxjYfLgJrt+hV7faxv7yNaX874Ms/5HY0XlHZA9iIP6bYRQKHi\neRN4NJJmO5hmwZB5cRSRfu6xIZ6X1dH5TQcr3TVr0Owl2+MRiQQfUo+/PlqV\nfaHRpt0L0kVKu+j8wLJvHwspI/fO92g31Mb+ccgBE6MKmQHa1sKpQLoR3a8+\n9ij2COwqBamMq0fOQc0YgBX2qIbbJSLf2SOYY+r8YEFDwjOFFA+vlPp7LwuP\nQJy/F0XmGIS9lI5hp8bSaWouQU+L+cdcmPaShiUDpFsd6E5tLq098bSSW/2/\nZ5MY\r\n=oTeg\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"6fe77b9d8a0b38276a82c183113a7425bb068a44","scripts":{"test":"mocha ./test/index.js"},"_npmUser":{"name":"cmsgov","email":"kalvin+npmcmsgov@navapbc.com"},"repository":{"url":"https://github.cms.gov/qpp/qpp-shared-healthcheck-node.git","type":"git"},"_npmVersion":"5.6.0","description":"health check endpoint for QPP APIs","directories":{},"_nodeVersion":"8.11.1","_hasShrinkwrap":false,"devDependencies":{"chai":"^4.2.0","mocha":"^4.0.1","express":"^4.0.0","supertest":"^3.0.0"},"peerDependencies":{"express":"^4.0.0"},"_npmOperationalInternal":{"tmp":"tmp/qpp-shared-healthcheck-node_0.3.0_1542386482736_0.48632919806844166","host":"s3://npm-registry-packages"}},"0.3.1":{"name":"qpp-shared-healthcheck-node","version":"0.3.1","author":{"name":"Centers for Medicare & Medicaid Services"},"license":"CC0-1.0","_id":"qpp-shared-healthcheck-node@0.3.1","maintainers":[{"name":"barbmiles","email":"barbara@adhocteam.us"},{"name":"cms-cis-qpp","email":"admin@semanticbits.com"},{"name":"bijujoseph","email":"biju.joseph@semanticbits.com"},{"name":"aaronmanne","email":"aaron.manne@semanticbits.com"},{"name":"branon.barrett","email":"branon.barrett@semanticbits.com"},{"name":"kyleapfel","email":"kyleapfel@gmail.com"},{"name":"chrkirsh","email":"chriskirshak@gmail.com"},{"name":"cagedcrown","email":"maurytlindo@gmail.com"},{"name":"rodmunoz","email":"rodmunoz@me.com"},{"name":"johanna-adhoc","email":"johanna@adhocteam.us"},{"name":"boristotle","email":"darrin.bennett@semanticbits.com"},{"name":"jamescgarrett","email":"jamescgarrett@gmail.com"},{"name":"catop-semantic","email":"cato.peterson@semanticbits.com"},{"name":"chetanmunegowda","email":"chetan.munegowda@semanticbits.com"},{"name":"88underoath","email":"jonathan.camargo@semanticbits.com"},{"name":"saritha.chittimalla","email":"saritha.chittimalla@semanticbits.com"},{"name":"suchint.nagra","email":"suchint.nagra@semanticbits.com"},{"name":"cmsds","email":"scott.weber@adhocteam.us"},{"name":"bernardadhoc","email":"bernard@adhocteam.us"},{"name":"shadford","email":"shadfordwise@gmail.com"},{"name":"erinrep","email":"erin@adhocteam.us"},{"name":"michael.okeefe","email":"michael.okeefe@semanticbits.com"},{"name":"jbishtawi","email":"jaybishtawi@outlook.com"},{"name":"andrew565","email":"andrew@andrewthecreator.com"},{"name":"scoringengine","email":"sb-qpp-npmjs-scoringengine@semanticbits.com"},{"name":"jrmce","email":"jrmce12@gmail.com"},{"name":"bartcone-sb","email":"bart.cone@semanticbits.com"},{"name":"pgrocholski","email":"pawel@grochol.ski"},{"name":"nwsparks","email":"noah.sparks@semanticbits.com"},{"name":"pbehnke","email":"phil@pbehnke.io"},{"name":"djacksonsb","email":"drew.jackson@semanticbits.com"},{"name":"seesleestak","email":"calvin.cieslak@gmail.com"},{"name":"nicholascgates","email":"nicholas.gates@semanticbits.com"},{"name":"pwolfertadhoc","email":"patrick.wolfert@adhocteam.us"},{"name":"ni.chia","email":"ni.chia@adhocteam.us"},{"name":"kevin-burchfield-sb","email":"kevin.burchfield@semanticbits.com"},{"name":"clkawell","email":"christopher.kawell@semanticbits.com"},{"name":"lavioli-sb","email":"lavie.ruan@semanticbits.com"}],"homepage":"https://github.com/CMSgov/qpp-shared-healthcheck-node#readme","bugs":{"url":"https://github.com/CMSgov/qpp-shared-healthcheck-node/issues"},"dist":{"shasum":"47ab6741103b6d9ac70093d45fd538f752b4bfba","tarball":"https://registry.npmjs.org/qpp-shared-healthcheck-node/-/qpp-shared-healthcheck-node-0.3.1.tgz","fileCount":16,"integrity":"sha512-N7Sohu2jegX6GrMYngcOK+uCKug5GBuhkM9vEJMAn3xtsJ2it3RLDyZQ0LHPBN0IV4+TrPooFABXGqXy1rIEHw==","signatures":[{"sig":"MEUCIQD8U1iFZD9a/kYyGHlUuBlACvc6gII9EHUlWZMzFf2bAwIgQZBGHeJ4hLtEB20+X5ZU4xs5sXWkrSaioCY+h6yiNsY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26002,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJf42RACRA9TVsSAnZWagAAnrMP/iGbE3pVMzd0lN7vqkG0\nDJDdP6rFZikk0+tipNlR24bIYbwZ9MvzmY6nqZ2QRKs4vIJ8s2nbNJXPjJqm\nl3NiXJAXQ3TTiWWp2kVvvRlNyOu13xbfdgsVsQJxOmj99gBR4RyKKpSbkITA\nEimEZd5QcTu2PfPVT2SRoPnTotZ0+QTHjQud+Tqr9ff1NxhYHsy3ubcu7Eg/\nin7eFVJ96DwTB8PVjlEadcbMmQRawFG9O59pruWd7ZlTHj3/+kkgjuTcorMJ\ng94ysf1z2BnaMa/baOOp7XwO1el8rYemZRblKxqPlz8CdOdCNFSpGzr8cr9P\nuhlJvD5/ANRuowntmOOsgbh4x/qtUSRM6L1gTECdqKfPCUJcFryijoytz1zM\nXmdFB7NXVi1ivSxgvu8xQpdTiVPzRcB34PJ+5yp0Mb54socz1+Esb1K/NX/I\nzHF7EeSNzfrGwhnQ5UaXi16rJhK5AbMaHjkKqerIF7YzS6XbIA1YNhl6bZW/\nQGt0832NkJ7Q4Uh9pJFkwfIOsSeEGRAR35IiARXXJWwHOQNxd2XpiT0DdUpo\nEHUVKanrJzELY61NNAm9HkmKgiem8m9lxZ7dRzlonw3AQJwRm+Nj5ZP50Zya\njp63p2SfGd8XX9PK2n55+FpmX47UXmR1uQCuvzctd3iHWE4ke7hR4fUShyly\noB8Y\r\n=GPip\r\n-----END PGP SIGNATURE-----\r\n"},"main":"index.js","gitHead":"7f92b3162a8492e1f6106dfb99046a476ab99d00","scripts":{"test":"mocha ./test/index.js"},"_npmUser":{"name":"bijujoseph","email":"biju.joseph@semanticbits.com"},"repository":{"url":"git+https://github.com/CMSgov/qpp-shared-healthcheck-node.git","type":"git"},"_npmVersion":"6.4.1","description":"Health check endpoint for QPP APIs","directories":{},"_nodeVersion":"10.15.3","_hasShrinkwrap":false,"devDependencies":{"chai":"^4.2.0","mocha":"^4.0.1","express":"^4.0.0","supertest":"^3.0.0"},"peerDependencies":{"express":"^4.0.0"},"_npmOperationalInternal":{"tmp":"tmp/qpp-shared-healthcheck-node_0.3.1_1608737855948_0.48852181383361426","host":"s3://npm-registry-packages"}}},"time":{"created":"2017-11-27T16:47:32.221Z","modified":"2026-08-20T13:49:28.654Z","0.1.1":"2017-11-27T16:47:32.221Z","0.1.2":"2017-11-27T19:51:24.339Z","0.2.0":"2018-04-09T21:56:54.518Z","0.3.0":"2018-11-16T16:41:22.865Z","0.3.1":"2020-12-23T15:37:36.116Z"},"bugs":{"url":"https://github.com/CMSgov/qpp-shared-healthcheck-node/issues"},"author":{"name":"Centers for Medicare & Medicaid Services"},"license":"CC0-1.0","homepage":"https://github.com/CMSgov/qpp-shared-healthcheck-node#readme","repository":{"url":"git+https://github.com/CMSgov/qpp-shared-healthcheck-node.git","type":"git"},"description":"Health check endpoint for QPP APIs","maintainers":[{"email":"sarah.sachs@adhocteam.us","name":"sarah-adhocteam"},{"email":"npmjs@softrams.com","name":"cms-cis-qpp"},{"email":"biju.joseph@semanticbits.com","name":"bijujoseph"},{"email":"kyleapfel@gmail.com","name":"kyleapfel"},{"email":"darrin.bennett@icf.com","name":"boristotle"},{"email":"chetan.munegowda@semanticbits.com","name":"chetanmunegowda"},{"email":"spoc-design@corbalt.com","name":"cmsds"},{"email":"sb-qpp-npmjs-scoringengine@semanticbits.com","name":"scoringengine"},{"email":"drew.jackson@semanticbits.com","name":"djacksonsb"},{"email":"nicholas.gates@semanticbits.com","name":"nicholascgates"},{"email":"patrick.wolfert@adhocteam.us","name":"pwolfertadhoc"},{"email":"ni.chia@adhocteam.us","name":"ni.chia"},{"email":"christopher.kawell@semanticbits.com","name":"clkawell"},{"email":"dominique.lomax@adhocteam.us","name":"dlomax30"},{"email":"kimberly.dibble@adhocteam.us","name":"kimadhoc"},{"email":"amy.lu@adhocteam.us","name":"alunpm"},{"email":"frederick.huang@semanticbits.com","name":"frederick.huang"},{"email":"Ben.Whitcomb@icf.com","name":"trzash-6891"},{"email":"troy.grosh@semanticbits.com","name":"tgroshsb"},{"email":"peter.stancic@softrams.com","name":"pstancic"},{"email":"john.manack@icf.com","name":"john-manack"},{"email":"tim.toy@semanticbits.com","name":"timwtoysb"},{"email":"sami.barghshoon@adhocteam.us","name":"sdbaradhoc"},{"email":"naman.bhatt@icf.com","name":"nominaman83"},{"email":"pete.mckinney@semanticbits.com","name":"petemckinneysb"},{"email":"david.berry@semanticbits.com","name":"davidberry_sb"},{"email":"gokhale@e14s.com","name":"gokhale"},{"email":"siva.srinivasulu@semanticbits.com","name":"sivasrinisb"},{"email":"snoelover18@gmail.com","name":"cruddyshad0w"},{"email":"korey.roberts@semanticbits.com","name":"sb_kmr"},{"email":"rodmunoz@me.com","name":"rodmunoz"},{"email":"60255@icf.com","name":"ddhecker"},{"email":"gerickson808@gmail.com","name":"gerickson808"},{"email":"aziza.meer@softrams.com","name":"azizakmeer"},{"email":"adilenghel@gmail.com","name":"adilenghel"},{"email":"james.kramer@semanticbits.com","name":"kramersb"},{"email":"benkwokdev@gmail.com","name":"bkwok"},{"email":"tarikuz.zaman@icf.com","name":"tarikuzz"},{"email":"michael.carter2@icf.com","name":"mjc3bb"},{"email":"joshua.curtis@icf.com","name":"chxm"},{"email":"murali.softrams@gmail.com","name":"muralisr"},{"email":"maurytlindoz@gmail.com","name":"molindoz"},{"email":"kimniedermaier@navapbc.com","name":"kim-cmsds"},{"email":"Andrii.Tatusko@icf.com","name":"andrii_tatusko"},{"email":"55009@icf.com","name":"msingh45"},{"email":"bhargav.korrapati@semanticbits.com","name":"bhargavk.semanaticbits"},{"email":"kkelley@triafed.com","name":"kkelley-triafed"},{"email":"walber.glez@gmail.com","name":"walberglez"},{"email":"QPPDevOpsTeam@triafed.com","name":"qppcisdevops"},{"email":"jdaniel@triafed.com","name":"jdanieltria"},{"email":"jakawell@gmail.com","name":"jakawell"},{"email":"michael.conway@icf.com","name":"mconway11"},{"email":"alex.tychynskyi@icf.com","name":"alextychynskyi"},{"email":"64014@icf.com","name":"merrin_fazzari"},{"email":"ahom@triafed.com","name":"andy-hom"},{"email":"kfard@triafed.com","name":"kfard"},{"email":"opensource@cms.hhs.gov","name":"cmsopensource"},{"email":"rodney@e14s.com","name":"rtdiggs"}],"readme":"# QPP Health Check Endpoint\nThis is the common QPP health check endpoint that is used by QPP services to make basic determinations if the service is up or down.\n\n## Dependencies\n* This route requires the [Express](https://expressjs.com/) framework.\n* Node versions tested: 10.x, 12.x\n\n## Adding to your project\n`npm install qpp-shared-healthcheck-node`\n\n## Testing locally\nYou may need to add node.js to your local environment in order to install the dependencies.  \nAfter running `npm install` on a freshly cloned project, run `npm test` to kick off the test suite.  \nIf any errors are found after running the tests on a newly cloned repo, please open an issue on the github repo page immediately and include the version of Node that is used during runtime.\n\n## Using\nOnce the package has been installed, you can load the route into wherever routes are handled in your application.\n\nBasic usage could be as follows:\n\n```javascript\nconst express = require('express');\nconst app = express();\nconst router = express.Router();\n\nconst sharedHealthcheck = require('qpp-shared-healthcheck-node');\nconst healthcheck = sharedHealthcheck.create();\n\napp.use(healthcheck);\napp.listen(3000);\n```\n\nYou can enable an RSS check to return 503s when memory usage crosses a configured threshold:\n\n```javascript\nconst healthcheck = sharedHealthcheck.create({\n  // Limit process to 1.4GB\n  maxRssBytes: 1400000000\n});\n\napp.use(healthcheck);\n```\n\nYou can return a custom 200 message by passing an object with the `okMessage` property:\n\n```javascript\nconst healthcheck = sharedHealthcheck.create({\n  okMessage: {\n    versions: {\n      customModule: 'v1.0.0'\n    },\n    status: 'ok'\n  }\n});\n\napp.use(healthcheck);\n```\n\nResponse body:\n```\n{\"versions\":{\"customModule\":\"v1.0.0\"},\"status\":\"ok\"}\n```\n\nOnce the application is running, you can hit the endpoint at `/health`.  In this case with our simple application above, we would start the application and navigate to `localhost:3000/health` and expect to see some results.\n\n\n## Want to Contribute?\n\nWant to file a bug or contribute some code? Read up on our guidelines for [contributing].\n\n[contributing]: /.github/CONTRIBUTING.md\n\n## Public Domain\nThis project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived\nthrough the CC0 1.0 Universal public domain dedication.\t\t\n\nAll contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to\ncomply with this waiver of copyright interest.\t\t\n\nSee the [formal LICENSE file](/LICENSE).\n\n","readmeFilename":"README.md"}