cfg is a minimal configuration API for Node.JS, with support for
environments, inheritance and command-line overrides.
fnonly if the current env is the same as
There's two ways to override settings. Imagine the following configuration:
var cfg = ;cfg;
node index.js --enable-my-boolean-flagnode index.js --disable-my-boolean-flagnode index.js --with-my-flag=valuenode index.js --with-my-flag="some value with spaces"
If you supply an option
argvPrefix with the value
'lb' for example, then
the option becomes
CFG_MY_BOOLEAN_FLAG=YES node index.jsCFG_MY_FLAG="woot woot" node index.js
CFG can be overriden by passing the
envPrefix option to
cfg is not concerned with what populates configuration. Layers of replication,
pub/sub, etc can be added as a separate module.
Everything is stored in memory, none of the signatures take callbacks
The sweet spot for
cfg is configuration that you want to reuse across modules
and scripts. Even though projects like
socket.io already include
configuration systems, certain configuration flags such as API keys you might
want to retrieve from a CLI script and your web app for example
In summary, keep your web-app related configuration flags in express, and put
those that are generic in
(The MIT License)
Copyright (c) 2011 Guillermo Rauch <firstname.lastname@example.org>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.