2.0.6 • Published 3 years ago
docenv v2.0.6
Docenv
Description
Simple wrapper for dotenv that let us describe (document) configuration parameters and define default values for them if not defined.
Installation
Using npm:
npm install docenv
or using yarn:
yarn add docenv
How to use
1- You'll need a .env file at your projects roots location.
Sample .env content:
SERVER_PORT=7337
2- Create a docenv-config.js
with defaults parameters and text explaining usage.
module.exports = [
{
"key": "SERVER_IP",
"help": "IP to listen on the server",
"value": "0.0.0.0" // Optional Default value
},
{
"key": "SERVER_PORT",
"help": "Port to listen on",
"value": "80",
"regex": /^(80|7337)$/ // Optional Validation
}
]
3- Initialize doc-env at your entry code.
Sample index.js content:
const { Config, initEnv} = require("docenv")
initEnv(require("./docenv-config.js"));
If some of your variables doesn't have default value and you .env doesn't define the value throw next error:
The envronment variable: [VARIABLE_NAME] must be defined in .env!
Help for [ VARIABLE_NAME]
* Variable Help
4- Use it
httpServer.listen(Config.SERVER_PORT, Config.SERVER_IP, resolve);