better-config

Simple Config Library

This is a simple config library for use in NodeJS. Get started with:

npm install --save better-config

Usage

var config = require('better-config');

Here are the ways to set the config - For a big project you probably want to set the defaults, then set a config.json file (if they have one). If there is no file, the set call does nothing.

// Plain vanilla object setting
config.message = 'hello world';
 
// Set using the set function
config.set({ message: 'this is the default value' });
 
// Set using a json file
config.set('./package.json');
 
// Set using a js file
config.set('./defaults.js');
 
// Set using a function
config.set(function () {
  return { sum: 1+1 }
});

You can simply access the config like you would any other object:

// Plain vanilla object get
console.log(config.message)
 
// Get by function
console.log(config.get('some.deep.array[0].property'))

Contributions welcome!

Credits

This library was initially made by the awesome team of engineers at Diamond.

If you haven't already, make sure you install Diamond!