turing-config
v0.50.0
Published
Hierarchical configuration with files, environment variables and command-line arguments.
Downloads
59
Readme
turing-config
Hierarchical configuration with files, environment variables and command-line arguments.
API
turing-config will merge configs from several sources into one config. Therefore it will override configs from following sources from default (1) to strongest (3):
- env variables
- default config
- process.env.ACTIVE_PROFILE specific config
The default config sets the base, ACTIVE_PROFILE specific config overrules default config and env variable config overrules everything.
Only the env variables specified in custom_env file will be merged into config.
Config Dir
The default config dir will be /config. To change that set the TURING_CONFIG_DIR env variable.
Default Config
Default configs are stored in a default.json file inside your config dir.
ACTIVE_PROFILE specific config
To add ACTIVE_PROFILE specific configs add a config file called {ACTIVE_PROFILE}.json to the config dir.
Env Variables
To add config values from env variables you have to create a file called custom_env.json.
get(configPath)
To get a config value simple require turing-config and call get(configPath) inside the config dir.
const config = require('turing-config');
const myConfigPathValue = config.get('my:config:path');
Contributors
- Benedikt Stemmildt
- Jonathan Meyer
License
Apache-2.0