{"_id":"@4dims/express-status-monitor","_rev":"2-460fda88bf8e4b9231bfb6f87ac6b7da","name":"@4dims/express-status-monitor","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@4dims/express-status-monitor","version":"1.0.0","description":"A simple middleware that returns the availability of the API and related services.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/piraveen/express-api-monitor.git"},"keywords":["node","api","status","express","monitoring","API-status"],"author":{"name":"Piraveen Kamalathas","url":"https://github.com/piraveen"},"license":"MIT","bugs":{"url":"https://github.com/piraveen/express-api-monitor/issues"},"homepage":"https://github.com/piraveen/express-api-monitor#readme","gitHead":"c17438212a2f28d064b2b9a5eeeb4813d164ba81","_id":"@4dims/express-status-monitor@1.0.0","_nodeVersion":"10.16.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-la1R5x7Srg0wQbIE6XDsbqXL4tZuPgvhKK4+tK7Hyol2WvTdudlQWvJZky3OMIcyjoDC0JuEs7MEFmo6NrPQEA==","shasum":"77288a76a4dd3df733f1bb688e37c01bc74b0897","tarball":"https://registry.npmjs.org/@4dims/express-status-monitor/-/express-status-monitor-1.0.0.tgz","fileCount":5,"unpackedSize":6675,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdJlbLCRA9TVsSAnZWagAAJ30P/jh+w8lki7+g5XbBEMUn\nBM6ntJhKasUd3x7SXVCS6ZMaiH4qhpTvf0rai3/C7VXCKkOPMfTBLRsCcpFg\n8IaM6z4StHq717+64jubRQMOTRLh1+8YfPGe6TlE5OkdHRyHlyFBROJXXLJm\n/eBgAA/tV21+fxBhEtGBMKaiU1EkYEndred8GWG+7UIuRuqVoR1Q3Sayhbqa\nEOORxYvRt8L5zATNTbUEPIkM/UeCxAOwqT0pf0sgEqtaK9+42PhWk2RXABUn\nY2hcwUX1T3ZrGBlvjvnDX6KTGOJE7YE/IACN1E9KejucaYPHCmwbbLdJ+oxf\nGiaOXlVa1jN++Xx/Zx8QHM2buqg+c7CQqb/whWIV68ci/E+lQFrBA9B544S9\nls8JSovFfHwx14tyUe0hiNZ4K4JhJjNQtQ9QCU71uqOCGTuDBqEVa1xQ5HGs\nzkHG5Eplq2vblwb0q0kkwtFJSay4bfd2iXpoML2K/xKjNh6jqGyWy1X7alaP\noQwoZYy2F5kF9g98CDh9qKSPAGZqVjuMZ5vpxqRnnaueNhDqsuDlEznrJcFO\nm2RlJPn7ML3NqtForfukjeivWUiJldOOubIZV9L7W52JXH8VbZav5Kg91Oz7\n3bhHQw0kezzlaBPn0u2TvLrVG/DPnIIH9Zs0skUHZbDqz07/IdlSO7+uQzF2\nPY/A\r\n=ywgH\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDah0O+LYJxGvmUke0ov2YiMoqYyHwehgZIx0IMqyKXEgIhAKkCIG8adZDRV65AEOWatwP+1nlsPlHv/nXJmLGIKunF"}]},"maintainers":[{"name":"piraveen","email":"opensource@4dims.com"}],"_npmUser":{"name":"piraveen","email":"opensource@4dims.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/express-status-monitor_1.0.0_1562793674250_0.2172455534786324"},"_hasShrinkwrap":false},"1.0.1":{"name":"@4dims/express-status-monitor","version":"1.0.1","description":"A simple middleware that returns the availability of the API and related services.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/piraveen/express-api-monitor.git"},"keywords":["node","api","status","express","monitoring","API-status"],"author":{"name":"Piraveen Kamalathas","url":"https://github.com/piraveen"},"license":"MIT","bugs":{"url":"https://github.com/piraveen/express-api-monitor/issues"},"homepage":"https://github.com/piraveen/express-api-monitor#readme","gitHead":"773ec2e1f6fed2e6a6811a4af62a0229fa3ae0dd","_id":"@4dims/express-status-monitor@1.0.1","_nodeVersion":"10.16.0","_npmVersion":"6.9.0","dist":{"integrity":"sha512-UFrNSLI4qyfJAuO5/G6JiOStEWULD0Y4Tlf2x+RWTPOrEV10KQG0SLsscqEaAxoSSBMwE+wvaUrE/feJwfTnVQ==","shasum":"fb0869b71bfd5e56b589512f9a01f76f0b33c33e","tarball":"https://registry.npmjs.org/@4dims/express-status-monitor/-/express-status-monitor-1.0.1.tgz","fileCount":5,"unpackedSize":6695,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdJlfGCRA9TVsSAnZWagAA7hoP+wfzYXLhueg/GyCSjLX2\n+IOyyJxjbUev09BaG4awoMsTH5YD8SKqYveWxhkSfDc3Teh+VwQXvRHC2t3A\n4KvNs3/1uefxtm1OofHv8rO+7w5W7BygXNK6uNpakIyhHcae5WN64LoejrlB\nkTCmpqBWh+nlONtAklCz0b2j+Z3RkzvdpQh/mHASPlb2WRPsB4O++gm+sAZS\nYunoI3dpnyfA1lwbiztcDFxc9v71IFhPLg4OJGBU6laqCKrTHHfl+O0khA9L\njCHyd6AS2hVqf0+0VRwRTYXgJLVY/GwTpSIelFTG2tLTXOclZeua5mlFg9fI\ntSwnUwIsVOHITI5njb5IsrBwXwDIXSFuVPw4ZcMb8YFLnsLaNRIpL5my0Kny\n7vE7SPQ4Fe5A9fr5O/v7Y9dSkHPjnHenY5VpVJginCnZWs6dGunCBEEBPQ2o\nOV1RlHExa2giy+pW9I8s3F27me5FtpiMJHLujKSU6Z8iKqkpdEb9znrnDzx9\ny9wnnsI8Ac/jiiWv1m/SqHzFydLyw1qgjpwYHE5NwHSp4f8unKjYq6il9KJ4\nrz+LeLUTSyY2ZjQ6c/B3z1ezCItPv4fMhDPpn5NQFvkWgJpe9EVgGmgsHMJr\nzUfrtfnFixxSfw4/Y/x0Ie6wilIs76t7OPDOb1889+DtL5xBVf2pjjChGZpL\nEa7Z\r\n=YBIF\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGyYPOv4tJGaJdb+tv4WfAkjXt4FtuK89wbBTD88XAbZAiB33+BwaaMKIlZ6krk6bBe+PDUm9E3gY7ssf0iRr09cLw=="}]},"maintainers":[{"name":"piraveen","email":"opensource@4dims.com"}],"_npmUser":{"name":"piraveen","email":"opensource@4dims.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/express-status-monitor_1.0.1_1562793926221_0.210136830539164"},"_hasShrinkwrap":false}},"time":{"created":"2019-07-10T21:21:14.052Z","1.0.0":"2019-07-10T21:21:14.386Z","modified":"2022-04-04T10:46:26.525Z","1.0.1":"2019-07-10T21:25:26.334Z"},"maintainers":[{"name":"piraveen","email":"opensource@4dims.com"}],"description":"A simple middleware that returns the availability of the API and related services.","homepage":"https://github.com/piraveen/express-api-monitor#readme","keywords":["node","api","status","express","monitoring","API-status"],"repository":{"type":"git","url":"git+https://github.com/piraveen/express-api-monitor.git"},"author":{"name":"Piraveen Kamalathas","url":"https://github.com/piraveen"},"bugs":{"url":"https://github.com/piraveen/express-api-monitor/issues"},"license":"MIT","readme":"# express-api-monitor\nA simple middleware that returns the availability of the API and related services.\n\n# Getting started\n\nInstall with:\n```\nnpm install --save @4dims/express-status-monitor\n```\n\nUse it in your express app:\n```\nconst app = require('express')();\nconst statusMonitor = require('@4dims/express-status-monitor');\n\n// Default\napp.use(statusMonitor());\n\n// With DB Monitor (Mongoose / Sequelize)\n\n// With Custom URL Path\napp.use(status({ path: '/api/status', db: true }));\n\n// respond with \"hello world\" when a GET request is made to the homepage\napp.get('/', function(req, res) {\n    res.send('hello world');\n});\n\napp.listen(3000, function () {\n    console.log('Example app listening on port 3000!')\n});\n```\n\n# Options\n### Custom URL Path\n```\n{ path: '/status'}\n```\n\n### API Monitoring: Enable/Disable\n```\n{ api: true }\n```\n\n### DB Monitoring: Enable/Disable\n```\n{ db: true }\n```\n\nIf DB is set to `true`, a DB instance should be provided\n- Mongoose `{ mongoose: mongoose }`\n- Sequelize `{ sequelize: sequelize }`\n\n#### DB Monitoring support\n- [x] Mongoose ORM (MongoDB)\n- [x] Sequelize ORM (MySQL, PostgreSQL, SQlite, ...)\n- [ ] MongoDB (coming soon)\n\n### Extras\nYou can return any JSON data with the extras property\n```\n{\n    extras: {\n        infoA: 1234\n        infoB: 1234\n        infoC: 'somethin'\n    }\n}\n```\n\n### Feedback\nSuggestions or improvements are most welcomed ! Open an [issue](https://github.com/piraveen/express-status-monitor/issues) if you want to help.\n\n### Author\nPiraveen Kamalathas <https://github.com/piraveen>\n","readmeFilename":"README.md"}