Skip to content

README.md

Latest commit

 

History

History
56 lines (41 loc) · 1.32 KB

README.md

File metadata and controls

56 lines (41 loc) · 1.32 KB

common-env

Build Status Deps Version

A little helper I use everywhere for configuration. Environment variables are a really great way to quickly change a program behavior.

npm

npm install common-env

Usage

var logger = console;
var env = require('common-env')(logger);

// AMQP_LOGIN="plop" AMQP_CONNECT=true node test.js
var config = env.getOrElseAll({
  amqp: {
    login: 'guest',
    password: 'guest',
    host: 'localhost',
    port: 5672,
    connect: false
  },

  FULL_UPPER_CASE: {
    PORT: 8080
  },

  MICROSTATS: {
    HASHKEY: 'B:mx:global'
  }
});

t.strictEqual(config.amqp.login, 'plop'); // converted from env
t.strictEqual(config.amqp.port, 5672);
t.strictEqual(config.amqp.connect, true); // converted from env
t.strictEqual(config.FULL_UPPER_CASE.PORT, 8080);

Changelog

v1.1.0

feat(options): allow user to ask common-env to not display env vars. values, closes #1 asked by @keruspe