getenv
Helper to get and typecast environment variables. This is especially useful if you are building Twelve-Factor-Apps where all configuration is stored in the environment.
Installation
npm install getenv
Usage
Set environment variables:
export HTTP_HOST="localhost"
export HTTP_PORT=8080
export HTTP_START=true
export AB_TEST_RATIO=0.5
export KEYWORDS="sports,business"
export PRIMES="2,3,5,7"
Get and use them:
var getenv = require('getenv');
var host = getenv('HTTP_HOST');
var port = getenv.int('HTTP_PORT');
var start = getenv.bool('HTTP_START');
if (start === true) {
}
var abTestRatio = getenv.float('AB_TEST_RATIO');
if (Math.random() < abTestRatio) {
} else {
}
var keywords = getenv.array('KEYWORDS');
keywords.forEach(function(keyword) {
});
var primes = getenv.array('PRIMES', 'int');
primes.forEach(function(prime) {
});
Methods
All methods accept a fallback value that will be returned if the requested environment variable is not set. If the fallback value is omitted and if the requested environment variable does not exist, an exception is thrown.
env(name, [fallback])
Alias for env.string(name, [fallback])
.
env.string(name, [fallback])
Return as string.
env.int(name, [fallback])
Return as integer number.
env.float(name, [fallback])
Return as float number.
env.bool(name, [fallback])
Return as boolean.
env.array(name, [type], [fallback])
Split value of the environment variable at each comma and return the resulting array where each value has been typecast according to the type
parameter. An array can be provided as fallback
.
env.multi({spec})
Return a list of environment variables based on a spec
:
var config = getenv.multi({
foo: "FOO",
bar: ["BAR", "defaultval"],
baz: ["BAZ", "defaultval", "string"],
quux: ["QUUX", undefined, "integer"]
});
env.disableFallbacks()
Disallows fallbacks in environments where you don't want to rely on brittle development defaults (e.g production, integration testing). For example, to disable fallbacks if we indicate production via NODE_ENV
:
if (process.env.NODE_ENV === 'production') {
getenv.disableFallbacks();
}
Changelog
v0.4.0
- Add getenv.disableFallbacks() support.
v0.3.0
- Add getenv.multi() support.
v0.2.0
v0.1.0
Authors
License
This module is licensed under the MIT license.