dotenv-schema

extend dotenv to support defaults, types and structure

don't limit your application configuration only to strings!

Note that this module does not modify process.env in any way. It parses process.env and then returns an object that reflects the provided schema. You should call to dotenv.config() to load .env file

Example

1
2configSchemaTest = {
3  test1: 'aaa', // simple string value. if there is TEST1 environment variable, it will get that value instead
4  test2: 1, // Numbers are parsed from .env
5  test3: 1.3, // Floats are parsed too
6  test4: false, // if env.TEST4 is 1,true,on... this will be true
7  test5: String, // specify type without default value
8  test6: Number,
9  test7: Boolean,
10  test8: Date,
11  test9: {
12    type: String, // specify type
13    default: 'abc', // default value if not found in .env
14  },
15  test10: {
16    type: Number, // specify type
17    value: 1, // specify value if not found in .env
18  },
19  test11: {
20    type: String,
21    // required: true, // will throw error if env.TEST11 is not defined
22  },
23  test12: {
24    envName: 'OTHER_NAME', // will read value from env.OTHER_NAME instead of TEST12
25  },
26  nested: { // keys can be nested
27    test13: String, // this will evaluate from 'NESTED_TEST13'
28    more: {
29      test13: { type: Boolean } // = NESTED_MORE_TEST13
30    },
31  },
32  camelCaseConversion: 1, // this will convert to environment variable 'CAMEL_CASE_CONVERSION',
33};
34
35const myAppConfig = require('dotenv-schema').config(configSchemaTest);
36
37console.log(myAppConfig);
38/*
39{ test1: 'aaa',
40  test2: 1,
41  test3: 1.3,
42  test4: false,
43  test5: '',
44  test6: '',
45  test7: false,
46  test8:
47   'Wed Dec 11 2019 12:31:46 GMT+0100 (Central European Standard Time)',
48  test9: 'abc',
49  test10: 1,
50  test11: '',
51  test12: '',
52  nested: { test13: '', more: { test13: '' } },
53  camelCaseConversion: 1 }
54*/
55

dumpConfig

1// dumpConfig does the reverse: it returns all lines with all of the keys defined in schema like .env file would look like
2// this is useful for generating .env files
3
4console.log(require('dotenv-schema').config(configSchemaTest));
5/*
6TEST1=aaa
7TEST2=1
8TEST3=1.3
9TEST4=false
10TEST5=
11TEST6=
12TEST7=false
13TEST8=Wed Dec 11 2019 12:42:50 GMT+0100 (Central European Standard Time)
14TEST9=abc
15TEST10=1
16TEST11=
17OTHER_NAME=
18NESTED_TEST13=
19NESTED_MORE_TEST13=
20CAMEL_CASE_CONVERSION=1
21*/
22