config-keys

Simple environment-based application settings for NodeJS.

Installation

Install the npm package.

npm install config-keys --save

Usage

The module will try to load config/settings.js file by default. We can configure this behavior using the load method. The best place to do this is in application's main file.

// read configuration file
var _ = require('config-keys').load('path/to/file.js');
// load
var _ = require('config-keys').load({ ... });

Anywhere in your application you can use the module as shown bellow.

var _ = require('config-keys');
console.log( _.data.keyName );

Configuration File

Settings file should look something like the example bellow.

// config/settings.js
module.exports = {
  default: { ... },
  production: { ... }
};

You can also create a local file (e.g. config/settings.local.js) to override data of the original file.

API

.load(what)

Type: Function Returns: Object

Reads the what parameter and stores/caches its content to data attribute. Note that what parameter can be a file path or an object with keys.

_.load('path/to/file.js');
_.load({ ... });

.read(what)

Type: Function Returns: Object

Reads the what parameter and returns it's content. Unlike the load method, this function does not cache and does not modify module's data.

_.read('path/to/file.js');
_.read({ ... });

.is(env)

Type: Function Returns: Boolean

Checks if the node process environment name equals to the env attribute.

console.log( _.is('development') );
// -> true

.env

Type: String Default: development

Node process environment name. Beside the NODE_ENV environment variable, the value is also affected when application is called with --env of -e command-line arguments (e.g. node -e staging app.js).

console.log( _.env );
// -> production

.data

Type: Object Default: {}

Configuration data object where default and {environment} keys are merged.

console.log( _.data.myName );
// -> xpepermint