ctavan

getenv

      throw new Error('GetEnv.Nonexistent: ' + varName + ' does not exist ' +

                      'and no fallback value provided.');

      throw new Error('GetEnv.DisabledFallbacks: ' + varName + ' relying on fallback ' + 

                      'when fallbacks have been disabled');

      throw new Error('GetEnv.NoInteger: ' + value + ' is not an integer.');

    var isInfinity = (+value === Infinity || +value === -Infinity);

      throw new Error('GetEnv.Infinity: ' + value + ' is set to +/-Infinity.');

    var isFloat = !(isNaN(value) || value === '');

      throw new Error('GetEnv.NoFloat: ' + value + ' is not a number.');

    var isBool = (value === 'true' || value === 'false');

      throw new Error('GetEnv.NoBoolean: ' + value + ' is not a boolean.');

      var isBool = (value === '1' || value === '0');

        throw new Error('GetEnv.NoBoolean: ' + value + ' is not a boolean.');

    if(typeof varName == 'string') { // default

      var value = _value(varName, fallback);

Object.keys(convert).forEach(function(type) {

getenv.array = function array(varName, type, fallback) {

  if (Object.keys(convert).indexOf(type) === -1) {

    throw new Error('GetEnv.ArrayUndefinedType: Unknown array type ' + type);

  return value.split(/\s*,\s*/).map(convert[type]);

    if(util.isArray(value)) { // default value & typecast

          result[key] = getenv(value[0], value[1]); // dirty, when case 1: value[1] is undefined

          result[key] = getenv[value[2]](value[0], value[1]);

          throw('getenv.multi(): invalid spec');

  "description": "Get and typecast environment variables.",

  "author": "Christoph Tavan <dev@tavan.de>",

  "homepage": "https://github.com/ctavan/node-getenv",

    "url": "git://github.com/ctavan/node-getenv.git"

[![Build Status](https://secure.travis-ci.org/ctavan/node-getenv.png)](http://travis-ci.org/ctavan/node-getenv)

Helper to get and typecast environment variables. This is especially useful if you are building [Twelve-Factor-Apps](http://www.12factor.net/) where all configuration is stored in the environment.

var host = getenv('HTTP_HOST'); // same as getenv.string('HTTP_HOST');

var abTestRatio = getenv.float('AB_TEST_RATIO');

var primes = getenv.array('PRIMES', 'int');

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.

Alias for `env.string(name, [fallback])`.

Return as boolean. Only allows true/false as valid values.

Return as boolean. Allows true/false/1/0 as valid values.

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`.

Return a list of environment variables based on a `spec`:

  foo: "FOO", // throws if FOO doesn't exist

  bar: ["BAR", "defaultval"], // set a default value

  baz: ["BAZ", "defaultval", "string"], // parse into type

  quux: ["QUUX", undefined, "integer"] // parse & throw

Return a parsed URL as per Node's `require("url").parse`. N.B `url` doesn't validate URLs, so be sure it includes a protocol or you'll get deeply weird results.

var serviceUrl = getenv.url('SERVICE_URL');

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') {

- Jan Lehnardt (@janl): `getenv.multi()` support.

- Tim Ruffles <timruffles@gmail.com>: `disableFallbacks()`, `url()`

This module is licensed under the MIT license.

process.env.TEST_GETENV_EMPTY_STRING = '';

process.env.TEST_GETENV_STRING = 'This is a string.';

process.env.TEST_GETENV_INFINITY1 = Infinity;

process.env.TEST_GETENV_INFINITY2 = -Infinity;

process.env.TEST_GETENV_NOT_REALLY_TRUE = '1';

process.env.TEST_GETENV_NOT_REALLY_FALSE = '0';

process.env.TEST_GETENV_WRONG_NUMBER_INPUT = '3 test';

process.env.TEST_GETENV_STRING_ARRAY1 = 'one';

process.env.TEST_GETENV_STRING_ARRAY2 = 'one, two ,three , four';

process.env.TEST_GETENV_STRING_ARRAY3 = 'one, two,';

process.env.TEST_GETENV_STRING_ARRAY4 = ' ';

process.env.TEST_GETENV_STRING_ARRAY5 = 'one;two:three,four';

process.env.TEST_GETENV_INT_ARRAY = '1,2, 3';

process.env.TEST_GETENV_INT_ARRAY_INVALID1 = '1, 2.2, 3';

process.env.TEST_GETENV_INT_ARRAY_INVALID2 = '1, true, 3';

process.env.TEST_GETENV_INT_ARRAY_INVALID3 = '1, abc, 3';

process.env.TEST_GETENV_FLOAT_ARRAY = '1.9,2, 3e5';

process.env.TEST_GETENV_FLOAT_ARRAY_INVALID1 = '1.9,true, 3e5';

process.env.TEST_GETENV_FLOAT_ARRAY_INVALID2 = '1.9, abc, 3e5';

process.env.TEST_GETENV_FLOAT_ARRAY_INVALID3 = '1.9, Infinity, 3e5';

process.env.TEST_GETENV_BOOL_ARRAY = 'true, false, true';

process.env.TEST_GETENV_BOOL_ARRAY_INVALID1 = 'true, 1, true';

process.env.TEST_GETENV_BOOL_ARRAY_INVALID2 = 'true, 1.2, true';

process.env.TEST_GETENV_BOOL_ARRAY_INVALID3 = 'true, abc, true';

process.env.TEST_GETENV_URL_1 = "tcp://localhost:80";

process.env.TEST_GETENV_URL_2 = "tcp://localhost:2993";

process.env.TEST_GETENV_URL_3 = "http://192.162.22.11:2993";

tests['getenv() same as getenv.string()'] = function() {

    var stringVar1 = getenv(item.varName);

    var stringVar2 = getenv.string(item.varName);

    assert.strictEqual(stringVar1, stringVar2);

tests['getenv.string() valid input'] = function() {

    var stringVar = getenv.string(item.varName);

    assert.strictEqual(stringVar, item.expected);

tests['getenv.string() nonexistent variable'] = function() {

    getenv.string('TEST_GETENV_NONEXISTENT');

tests['getenv.string() nonexistent variable with fallback'] = function() {

  var stringVar = getenv.string('TEST_GETENV_NONEXISTENT', expect);

  stringVar = getenv('TEST_GETENV_NONEXISTENT', expect);

tests['getenv.int() valid input'] = function() {

tests['getenv.boolish() valid input'] = function() {

    varName: 'TEST_GETENV_NOT_REALLY_FALSE',

    varName: 'TEST_GETENV_NOT_REALLY_TRUE',

    var boolVar = getenv.boolish(item.varName);

    assert.strictEqual(boolVar, item.expected);

tests['getenv.boolish() invalid input'] = function() {

    { varName: 'TEST_GETENV_EMPTY_STRING' }

      var boolVar = getenv.boolish(item.varName);

tests['getenv.bool() nonexistent variable'] = function() {

    getenv.bool('TEST_GETENV_NONEXISTENT');

tests['getenv.bool() nonexistent variable with fallback'] = function() {

  var boolVar = getenv.bool('TEST_GETENV_NONEXISTENT', expect);

tests['getenv.array() valid string (default) input'] = function() {

    varName: 'TEST_GETENV_STRING_ARRAY1',

    varName: 'TEST_GETENV_STRING_ARRAY2',

    expected: ['one', 'two', 'three', 'four']

    varName: 'TEST_GETENV_STRING_ARRAY3',

    varName: 'TEST_GETENV_STRING_ARRAY4',

    varName: 'TEST_GETENV_STRING_ARRAY5',

    var arrayVar = getenv.array(item.varName);

    assert.deepEqual(arrayVar, item.expected);

tests['getenv.array() valid integer input'] = function() {

    var arrayVar = getenv.array(item.varName, 'int');

    // @TODO Something like https://github.com/joyent/node/issues/594 would be

    assert.strictEqual(arrayVar.length, item.expected.length);

    for (var i = 0; i < item.expected.length; i++) {

      assert.strictEqual(arrayVar[i], item.expected[i]);

tests['getenv.array() invalid integer input'] = function() {

    { varName: 'TEST_GETENV_INT_ARRAY_INVALID1' },

    { varName: 'TEST_GETENV_INT_ARRAY_INVALID2' },

    { varName: 'TEST_GETENV_INT_ARRAY_INVALID3' }

      var data = getenv.array(item.varName, 'int');

tests['getenv.array() valid float input'] = function() {

    var arrayVar = getenv.array(item.varName, 'float');

tests['getenv.array() invalid float input'] = function() {

    { varName: 'TEST_GETENV_FLOAT_ARRAY_INVALID1' },

    { varName: 'TEST_GETENV_FLOAT_ARRAY_INVALID2' },

    { varName: 'TEST_GETENV_FLOAT_ARRAY_INVALID3' }

      var data = getenv.array(item.varName, 'float');

		@@ -14,3 +14,3 @@ var util = require("util");
		if (fallbacksDisabled) {
		throw new Error('GetEnv.DisabledFallbacks: ' + varName + ' relying on fallback ' +
		throw new Error('GetEnv.DisabledFallbacks: ' + varName + ' relying on fallback ' +
		'when fallbacks have been disabled');
		@@ -54,4 +54,17 @@ }

		return (value === 'true');
		return (value === 'true')
		},
		boolish: function(value) {
		try {
		return convert.bool(value)
		}
		catch(err) {
		var isBool = (value === '1' \|\| value === '0');
		if (!isBool) {
		throw new Error('GetEnv.NoBoolean: ' + value + ' is not a boolean.');
		}

		return (value === '1');
		}
		},
		url: url.parse
		@@ -58,0 +71,0 @@ };

		@@ -11,3 +11,3 @@ {
		],
		"version": "0.5.0",
		"version": "0.6.0",
		"homepage": "https://github.com/ctavan/node-getenv",
		@@ -14,0 +14,0 @@ "repository": {

		@@ -81,4 +81,8 @@ # getenv

		Return as boolean.
		Return as boolean. Only allows true/false as valid values.

		### env.boolish(name, [fallback])

		Return as boolean. Allows true/false/1/0 as valid values.

		### env.array(name, [type], [fallback])
		@@ -124,2 +128,5 @@

		### v0.6.0
		- Added getenv.boolish() support.

		### v0.5.0
		@@ -126,0 +133,0 @@ - Add getenv.url() support.

		@@ -224,3 +224,38 @@ var assert = require('assert');

		tests['getenv.boolish() valid input'] = function() {
		var data = [{
		varName: 'TEST_GETENV_FALSE',
		expected: false
		}, {
		varName: 'TEST_GETENV_TRUE',
		expected: true
		}, {
		varName: 'TEST_GETENV_NOT_REALLY_FALSE',
		expected: false
		}, {
		varName: 'TEST_GETENV_NOT_REALLY_TRUE',
		expected: true
		}];

		data.forEach(function(item) {
		var boolVar = getenv.boolish(item.varName);
		assert.strictEqual(boolVar, item.expected);
		});
		};


		tests['getenv.boolish() invalid input'] = function() {
		var data = [
		{ varName: 'TEST_GETENV_STRING' },
		{ varName: 'TEST_GETENV_EMPTY_STRING' }
		];

		data.forEach(function(item) {
		assert.throws(function() {
		var boolVar = getenv.boolish(item.varName);
		});
		});
		};


		tests['getenv.bool() nonexistent variable'] = function() {
		@@ -227,0 +262,0 @@ assert.throws(function() {

New alerts

Fixed alerts

Improved metrics

Worsened metrics