![\"author](\"https://img.shields.io/npm/v/express-status-validate.svg\")
\n ![\"author](\"https://img.shields.io/badge/author-shawshankkumar-orange\"){kind=icon}
\n ![\"author](\"https://img.shields.io/npm/l/express-status-validate.svg\")
\n\n \n \n\n A dead simple npm library to validate express.js response status codes.\n
\n\n## Inspiration for this package!\n\n1. To learn how to make packages 😉\n2. I spent around 40-50 minutes debugging why [SRMKZILLA's](https://srmkzilla.net) backend kept crashing. Found out someone passed the mongo error codes(single digit) to express and viola.\n3. Bun v1 came out and I decided to ditch pnpm and node. \n\n## What does it do?\n\nIt does what a middleware should, it sits quietly and on a day to day basis, you never notice it. Express is great, but it can be better. In TypeScript, passing a wrong status code is not that easy. But in JavaScript? One could pass a tank and the code would run (Thanks JS :) ). This package safeguards your app from throwing unwanted errors or crashing. What can you pass?\n\n1. If you pass a valid status code like 200, it works. It doesn't change anything in the original status code.\n2. BUT, if you pass \"200\" or \"200OK\", it converts it to 200 and sends it. But what if you pass something like 799 (invalid status code)? In that case a default status code is set and sent.\n3. And you guesses correct, you can easily set the default status code you want.\n\n## How to use it in your JS/TS project?\n\n1. CD into the root folder of your project!\n2. Install [express-status-validate](https://www.npmjs.com/package/express-status-validate) using bun (bun is cool, yarn is boring and npm is npm.) Pnpm is also cool btw :p\n\n```\nbun add express-status-validate\n```\nor\n\n```\npnpm i express-status-validate\n```\n\nor\n\n```\nnpm i express-status-validate\n```\n\nor\n\n```\nyarn add express-status-validate\n```\n\n3. Open the entry point of your express app.\n\nOur express application before adding the package:\n\n```\nconst express = require(\"express\");\n\nconst app = express();\n\napp.get(\"/healthcheck\", (req, res) => {\n //This should throw an error and crash.\n res.status(200123).send(\"OK\");\n});\n\napp.listen(3000, () => {\n console.log(\"Server started on port 3000\");\n});\n\n```\n\nAfter adding the [express-status-validate](https://www.npmjs.com/package/express-status-validate) :\n\n```\nconst express = require(\"express\");\nconst expressStatusValidate = require(\"express-status-validate\");\n\nconst app = express();\n\n// 500 is optional, you can pass any valid http status code\napp.use(expressStatusValidate(500));\n\napp.get(\"/healthcheck\", (req, res) => {\n //This should throw an error and crash an application but it doesn't anymore.\n res.status(200123).send(\"OK\");\n});\n\napp.post(\"/healthcheck\", (req, res) => {\n //This should throw an error and crash an application but it doesn't anymore.\n res.status(\"200abs\").send(\"OK\");\n});\n\napp.listen(3000, () => {\n console.log(\"Server started on port 3000\");\n});\n\n```\n\nCheckout this [replit example](https://replit.com/@ShashankKumar12/express-status-validate?v=1#index.js)\n\n> **_NOTE:_** app.use(expressStatusValidate(500)) must be on top to work as desired.\n\n## Examples:\n\nWe are in the process of adding more examples and testing this library to make sure it works smoothly everywhere. Currently we have the following examples (Shoutout to [Harshit Singh, my roommate :p](https://github.com/whiletrueee) for being the first user of this library) :\n\n1. [JavaScript Example](https://github.com/shawshankkumar/express-status-validation/tree/main/example/js-example)\n2. [TypeScript Example](https://github.com/shawshankkumar/express-status-validation/tree/main/example/ts-example)\n\n## License 📜\n\n`express-status-validate` is available under the ISC license. See the [LICENSE](https://github.com/shawshankkumar/express-status-validation/blob/main/LICENSE) file for more info.\n\n## Contributing 🤝\n\nPlease read [Contributing.md](https://github.com/shawshankkumar/express-status-validation/blob/main/Contributing.md) for details on our code of conduct, and the process for submitting pull requests to us.\n\n## How to contribute to this project:\n\n1. Fork it 😜 and make sure you have Node(>14) installed!\n2. Install the pnpm using\n\n```\nnpm i -g pnpm\n```\n\n3. Install the dependencies\n\n```\ncd package && pnpm i\n```\n\n4. Do you magic (We recommend that you stick to the code and not configuration files unless there is a specific reason to do so)🪄\n5. Build the TypeScript\n\n```\npnpm run build\n```\n\n6. Run npm link and move to the examples and run npm link