Imagine you have a configuration file at .env with the following:
FOO=barBAZ=2BEEP=falseBOOP=some,thing,that,goes,wow# note how we use an asterisk here to turn off the parsing for this variableBLEEP=false*# note how we use an asterisk in the array to turn off parsing for an array key valuePING=ping,true*,2,100# note a string between bacticks won't be parsedPONG=`some,thing,that,goes,wow`
After using this plugin, the environment variables are parsed to their proper types.
To test it out, simply log the returned object in your console:
console.log(env);
And you'll see that it outputs the properly parsed variable types:
{ // String FOO: 'bar', // Number BAZ: 2, // Boolean BEEP: false, // Array BOOP: [ 'some', 'thing', 'that', 'goes', 'wow' ], // NOTE: this was not parsed due to the * asterisk override above BLEEP: 'false', // NOTE: only the "true*" above was opted out through the use of an asterisk PING: [ 'ping', 'true', 2, 100 ], // NOTE: this was not parsed because the string was between bacticks PONG: 'some,thing,that,goes,wow'}
If your configuration line ends in * it will not be parsed by this package, which allows you to keep values as the String variable type if needed. Also when you encapsulate a value between bacticks e.g. `value`, the value won't be parsed and it will return as a String variable. This can be used in situations where you for example have a , inside your string and it should not be parsed as an array.
Usage
This package works well with dotenv, however we also recommend to use dotenv-extended and dotenv-expand as we do in Lad. You could also simply just use Lad or specifically.