load-config-file
Load the config file as a plain object.
- The config file format can be registered.
- The registered file format order is the search order.
- the virtual file system can be specfied:
loadConfig.setFileSystem(fs)
fs.path = require('path.js/lib/path').path
for the virtual POSIX path.
- you must set the path first before call setFileSystem.
Usage
var loadConfig = require('load-config-file');
var yaml = require('js-yaml');
var cson = require('cson');
loadConfig.register(['.yaml', '.yml'], yaml.safeLoad);
loadConfig.register('.cson', cson.parseCSONString.bind(cson));
loadConfig.register('.json', JSON.parse);
console.log(loadConfig('config'));
loadConfig('config', function(err, result){
if (err) {
console.log('error:', err);
} else {
console.log(result);
}
})
API
var config = require('load-config-file');
config.register(extensionNames, parserFunc)
: register the configuration file format to
load. return the configurators if successful.
extensionNames
(Sting|ArrayOf String): the configuration file extension name(s)
with dot.parserFunc
Function(context): the configuration context parser function:
- parse the configuration context and return the plain object.
config.setFileSystem(fs)
: set your favour file system. defaults to 'fs'.
- the "file system" must implement
readFile(path[, options], done)
and readFileSync(path[, options])
load(path, options, done)
: Asynchronously load config from file
- options
raiseError
(Boolean): raise error if nothing loaded defaults to false.exclude
(String|ArrayOf String): excludes some files.encoding
(String): the file encoding name. defaults to 'utf8'.
- return the plain object and the
$cfgPath
property added if successful.
loadSync(path, options)
: Synchronously load config from file
- return the plain object and the
$cfgPath
property added if successful.
Changes
v0.2
-
raiseError option to load function asynchronously.
-
add the $cfgPath
(String) non-enumerable property to the result.
-
add object usage supports:
var cfgObj = new Config(aPath, aOptions)
result = cfgObj.loadSync()
TODO
- ! how to use the specified promise library via any-promise?
- currently use the bluebird by default.
License
MIT