env-safeguard
v1.0.4
Published
A lightweight utility to validate environment variables and prevent runtime errors caused by missing or misconfigured .env values.
Downloads
469
Maintainers
Readme
env-safeguard
A lightweight Node.js utility to validate environment variables at startup and prevent runtime errors caused by missing or misconfigured .env values.
Installation
npm install env-safeguardIMPORTANT
NO NEED TO INSTALL dotenv in your NodeJS project
Features
- Validate required environment variables
- Detect missing variables
- Validate data types (
string,number,boolean) - Generate
.env.exampleautomatically - Clear and readable error messages
- Lightweight and easy to use
Usage
const { checkEnv } = require("env-safeguard");
checkEnv({
PORT: "number",
MONGO_URI: "string",
DEBUG: "boolean"
});If the environment variables are valid, your application will continue running normally.
Example .env
PORT=3000
MONGO_URI=mongodb://localhost:27017/mydb
DEBUG=trueExample Error Output
❌ Environment validation failed
Missing variables:
- JWT_SECRET
Invalid types:
- PORT must be a number`Supported Types
| Type | Description |
|-----|-------------|
| string | Any text value |
| number | Numeric value |
| boolean | Must be true or false |
License
This project is licensed under the MIT License.
You are free to use, modify, and distribute this software with proper attribution.
Author
Ayantik Sarkar
- GitHub: https://github.com/ayantik2006
- LinkedIn: https://www.linkedin.com/in/ayantiksarkar
Acknowledgements
Thanks to the open-source community for building tools that make Node.js development easier.
Special thanks to developers who rely on environment-based configuration and inspired the idea behind env-safeguard.
Contributing
Contributions, issues, and feature requests are welcome.
Feel free to open a pull request or create an issue.
⭐ If you find this package helpful, consider giving it a star on GitHub!
