yacl

load config from a given environment

YACL

Yet Another Config Loader. A loader of config given an environment. By default it will load the 'default' configuration and by specifying the environment the default configuration can have some property overriden by the environment configuration.

It uses the config-templator by LoicMahieu.

Getting Started

npm install --save yacl

Supposing that you have a directory that contains configurations files in './config'.

var config = new ConfigLoader();
 
config.addDir( __dirname + '/config');
config.setEnv('development');
 
config.start(function (err) {
    if(err)
      throw new Error(err)
    console.log(config.toJSON());
});
  • constructor: new ConfigLoader([config[, lookup]])
    • config : default config that have priority to every config files
    • lookup : default: ['default', 'user-default', '{env}', 'user-{env}'] ( {env} is replaced by current environment )
  • addDir: add a directory that contains the environment files
  • setEnv: it takes a string as argument and set it as its environment by default the environment is 'default' or 'development' if it exists.
  • start: merge the configuration file into the config object.
  • toJSON: get the config into JSON format.
  • applyConfig: it takes an object as arguments and apply it on the current configuration.

License

Licensed under ISC. Copyright (C) 2014 iGLOO / Woobie S.P.R.L. (Loïc Mahieu loic@igloo.be)

Copyright (C) 2014 iGLOO / Woobie S.P.R.L. (Loïc Mahieu loic@igloo.be)
 
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
 
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.