TheThing/nconf-lite
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[doc] Document lowerCase option in .env(options) (#268)

Browse source 
- Add missing documentation about the lowerCase option
This commit is contained in:
Matt Hamann 2017-08-15 23:58:13 -04:00 committed by GitHub
parent 5e8a34d6cf
commit 552300a687
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -205,13 +205,27 @@ Responsible for loading the values parsed from `process.env` into the configurat
// Get the value of the env variable 'database__host'
var dbHost = nconf.get('database:host');
//
// Can also lowerCase keys.
// Especially handy when dealing with environment variables which are usually
// uppercased while argv are lowercased.
//
// Given an environment variable PORT=3001
nconf.env();
var port = nconf.get('port') // undefined
nconf.env({ lowerCase: true });
var port = nconf.get('port') // 3001
//
// Or use all options
//
nconf.env({
separator: '__',
match: /^whatever_matches_this_will_be_whitelisted/
whitelist: ['database__host', 'only', 'load', 'these', 'values', 'if', 'whatever_doesnt_match_but_is_whitelisted_gets_loaded_too']
whitelist: ['database__host', 'only', 'load', 'these', 'values', 'if', 'whatever_doesnt_match_but_is_whitelisted_gets_loaded_too'],
lowerCase: true
});
var dbHost = nconf.get('database:host');
```