{"_id":"@artemkv/health","_rev":"3-075393ad3cd0dcd64a6f3d0cc245b230","name":"@artemkv/health","dist-tags":{"latest":"1.1.1"},"versions":{"1.0.0":{"name":"@artemkv/health","version":"1.0.0","description":"REST Health Endpoint","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Artem Kondratyev"},"dependencies":{"@artemkv/statuscodes":"1.0.2"},"license":"ISC","_id":"@artemkv/health@1.0.0","_npmVersion":"6.4.1","_nodeVersion":"10.14.2","_npmUser":{"name":"artemkv-owner","email":"artemkv@gmail.com"},"dist":{"integrity":"sha512-sPc2f2mdhJZF0AwVUXsOXWhdULYP7SMzbIzYkG6OFVZwsJJVKeDz1SjyWeIHPLkNPkWBYJOfKAyyxl/9bAYhPQ==","shasum":"43879f4884c9686c4601e2c7e9269d2ce65d0837","tarball":"https://registry.npmjs.org/@artemkv/health/-/health-1.0.0.tgz","fileCount":4,"unpackedSize":907,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcYvgeCRA9TVsSAnZWagAAW0YP/20+yxUKHBdprJ9tKlSW\noU0k05G8nz5wJ8KphN6BOz7tjB/iuCtp52K3hZSr5Nqu6jOOCULt+PARtD+p\nz+WzalWwUXG0qx4NOjX+yFdRU+02NCJmvELv32dvt/8SD+zuw/v2PAZ3Kcbb\nZd2H8n4ZmYDjz+2Jql7dVqS9Wi638+dXNzYMA3OM8UkBplRdsnxWOWdtS0DL\n76xW70/LfO8hOtBFPX/Embg0MgqnFXgF4/n0DZVxSpD6DeeMeUy3QGObluP+\nGNYZrJ69G/dyo4HaOQIgRQORX4OCW61n2C8DjxwHnJFDE1LM45hYL2GygBFc\nrkRbgh6Q0JiU+zPyBMMEZuoVBTrp6a/L+rbNDa3DppJP2o6Jgu1HHcU35QZt\nHA3f7Tb+FOugQZqvuPoOZL1dKYkgfNvXyYgRacBYQoau/beQONmuXlCSD5Qd\nOs8vtEVA5WohNUqUd1sqdgGu3HYMbqTcdZh0i4mCZBRrvfIXo60ZbB3Kw7ft\nP5ydSkgu+3n0e1FlougNhc0U/czP9bwYss+A+y4MFwTizZ/GVYygbWwLbJYK\nUFOxRQIXi0Lar5620Cqd9o+tyHiULnA78YMiWrC2393yc6drr6CFw8UNs+qW\ngsUMZezQXhjVMRV4zj7KaLMd95zgKWW4ybKZgrZ3zL6Ya0ELordJT8Q/NbR4\n71zO\r\n=DXvx\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCICv6fXS/gQ0Ih+LcpvT3MEFa8jkv4M5kEk/3tjfsKUIaAiB7RiaHeZQsNxFO0WduL91pzzlUEOS2qKt9plz4PQsByQ=="}]},"maintainers":[{"name":"artemkv-owner","email":"artemkv@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/health_1.0.0_1549989918084_0.13527540926167814"},"_hasShrinkwrap":false},"1.1.0":{"name":"@artemkv/health","version":"1.1.0","description":"REST Health Endpoint","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Artem Kondratyev"},"dependencies":{"@artemkv/statuscodes":"1.0.2"},"license":"ISC","_id":"@artemkv/health@1.1.0","_npmVersion":"6.4.1","_nodeVersion":"10.14.2","_npmUser":{"name":"artemkv-owner","email":"artemkv@gmail.com"},"dist":{"integrity":"sha512-ml38SbZNmO/rBCWnDU6AcX9pRROOyQ0nPkcJZbuCSnm/1Si/CS3XR8e6VG7W4VObMqm6A7sugxiG1Gbyi82B6A==","shasum":"3edececf20cba98dfb541ce4cf5cacef84a8ec1a","tarball":"https://registry.npmjs.org/@artemkv/health/-/health-1.1.0.tgz","fileCount":4,"unpackedSize":2409,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdj8BvCRA9TVsSAnZWagAA0JMQAJf4OAN4QFucyN8l+QfV\nzvFlauCw9T9kjgulVMp/bm383WmioZmIsZMaifmRV44K/1AEnF/7F2/nF69y\nxlVdFik8U7CDCgoAfOh/eqb3agdXOKNKAAWm+YAU53rNnKyiuVliWHPc9BbO\nL4AtYPQH9zM8Q4Xv8ib2iG7ccnegotqTazFfC4gZs8gC+GFGLKRSp2CuZzPS\nEAYBdEjVH2+6z0Aq4PN0RyIK6Lgdkxe5bES8EMW7O5qk9zOzDSYQ6yg22yn2\nYpXUgp5ijytOJys/viQ6FmVDpgi1CtBEL5QpVUvQ2of7j/iON1ADa+I42tYv\nufoy28MePlR+3IU5U4lF/Sb9EhGC1MfKisImRCuajNfDH8hen31KhO7rqf6Y\numtf/IKYyRZQgZy2mAv/EavgAb6eScZYml/Wa9O61+0Yp9dK0f206hkBoycu\n8YkVWyOeLDsmt0s05qKLnAz5pWXWClWlNCCeRF3yjPdlptodLQy/Hf/otebq\nMViLxSI1fXMbUYril2z+gbf4fH928ySdg+8KP+XrspEJK1i6AWLdAri3KnJ0\naqdNECxcPT4wy1+QwvtldZEa+XB9O+2d2T/5UWZ3EpNcngXUO97zk8Hkv7r9\n4oxoYxbGDogj1usmrk0xPWksALXBUxRbNo4wiCazH+CI31OzONeBu0T0R5cE\ndn4b\r\n=StBk\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCJXZqTiyXofgPxhFjw7sGcroUzn3yjsU/JKWKQ6epfrQIhAPibJt1qJTpMh8w2iyVF9iGuUaNqFSuYQshDQ77fh3/B"}]},"maintainers":[{"name":"artemkv-owner","email":"artemkv@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/health_1.1.0_1569701999228_0.6160130107095421"},"_hasShrinkwrap":false},"1.1.1":{"name":"@artemkv/health","version":"1.1.1","description":"REST Health Endpoint","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"author":{"name":"Artem Kondratyev"},"dependencies":{"@artemkv/statuscodes":"1.0.2"},"license":"ISC","_id":"@artemkv/health@1.1.1","_npmVersion":"6.4.1","_nodeVersion":"10.14.2","_npmUser":{"name":"artemkv-owner","email":"artemkv@gmail.com"},"dist":{"integrity":"sha512-0S4VynR0CgkwFqlSwP1OfiCbOwcNBz+fMn0UsUzaPZIsjFxmP0dkGk+EsOvCYe6AjOolm05hw1n74wx9g7ON0g==","shasum":"707b3c066e622670bf9e92014f0840c11beea810","tarball":"https://registry.npmjs.org/@artemkv/health/-/health-1.1.1.tgz","fileCount":4,"unpackedSize":2613,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdj8FSCRA9TVsSAnZWagAALDAP/2Qq0uLVv+kNLrEeNZ3T\n+5aNvsOktD7wda4c8cqyKb/rjtk3DXKJqPODl8iAOy/rsfaKHaILT1DRyVy9\nKbVXD6EMKIjYD5RoJBtBeo3PZfnjxDotJkYrN1CxuAhvBVxbNjsc0BsNgtRP\nA11+srqlFjlGFiPJtA+m5VXuR1n49Yjm8adPK6bK5GYq0IpuISxqqIDgpNyx\naAMhlKmi6DzxeI+RKGh3gz70vEpcxdox5zho7KPamlfe4ogWQARFOTEP4Xea\nYzGQlp2lFQeCUYfbUfPZYue7yanPWQ1WOrJzP1gUiUFcQy5zBk4HLbYadbVD\nuu8LkG1x5h7DZAA6w27kwf0Ilfmtw4xZWZeu+0uhQbm3iiv9CV0iftoIkx+v\nCbyajwu4XtTfhu+Vj8pAizbErHDSbl6XlTBsnqfKLSnbqcgqf4TXH4m9mU0F\nQ2f7TUYXn9ys5YeTUMcOqFYLpi2O92ailn61fix4xrLb/LXEQcybBy/GwUN8\n5DW4tfh9xHrouFCXyyG4TmD3xd9HqWxVQ78Fquz4tUGH8FRxWoU8cIQT3JuR\nVyufSO2GkpeX596XNOFkwLEtmC4leO7ZBtN9z5SPmP1yNb5cNrutoMWr4fJP\nj0iaTfRt0aAlfb5kWN+J/kEv9ljcdUqewMdGxDC5TTprC8JHGwLF2uW6pG8U\n1TLa\r\n=QJQK\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIF9O8i5HJH1Ewf6UAAIbiHD/iCBUCvAdbCQ+F27cIZI0AiEAxYKNndsaPExX+oMIkBK3DAlZkvKIlRzRCwCOS2ycB3U="}]},"maintainers":[{"name":"artemkv-owner","email":"artemkv@gmail.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/health_1.1.1_1569702225492_0.8279630839437928"},"_hasShrinkwrap":false}},"time":{"created":"2019-02-12T16:45:18.039Z","1.0.0":"2019-02-12T16:45:18.262Z","modified":"2022-04-04T15:36:42.557Z","1.1.0":"2019-09-28T20:19:59.410Z","1.1.1":"2019-09-28T20:23:45.684Z"},"maintainers":[{"name":"artemkv-owner","email":"artemkv@gmail.com"}],"description":"REST Health Endpoint","author":{"name":"Artem Kondratyev"},"license":"ISC","readme":"@artemkv/health - REST Health Endpoint\r\n=======\r\n\r\n```js\r\nconst connect = require('connect');\r\nconst health = require('@artemkv/health');\r\n\r\nlet server = connect();\r\n\r\nserver\r\n    .use('/health', health.handleHealthCheck)\r\n    .use('/liveness', health.handleLivenessCheck)\r\n    .use('/readiness', health.handleReadinessCheck)\r\n\r\n// Start the server\r\nlet env = process.env;\r\nlet port = env.NODE_PORT || 8000;\r\nlet ip = env.NODE_IP || 'localhost';\r\nserver.listen(port, ip, function () {\r\n    console.log('Application started');\r\n    console.log('http://' + ip + \":\" + port + '/');\r\n\r\n    // everything has been initialized\r\n    health.setIsReady();\r\n});\r\n```\r\n\r\nhealth endpoint is an older implementation, it always returns 200 OK\r\n\r\nliveness returns 200 OK, unless you call ```health.setLiveness(false);```\r\n\r\nreadiness returns 503 Service Unavailable, until you call ```health.setIsReady();```","readmeFilename":"readme.md"}