JarCastingsnyk-config
Loads the configuration for your module.
Usage
Although you can require this module directly, it's recommended you create your own config.ts file that can be cached by the require system and called without a path:
// config.ts
import { loadConfig } from 'snyk-config';
export const config = loadConfig('<directory with config files>');
// in app.ts
import { config } from './config';
// in foo.ts
import { config } from './config'; // matches config in app.ts
Method
The config loader will look for the following values in order of priority, specifically, if a property appears in multiple layers of config (below) the first found is used:
- process environment values prefixed with
SNYK_ - process arguments
- a
config.secret.jsonfile in the path specified by:- the
secretConfigoption, or - the environment variable
CONFIG_SECRET_FILE, or - in the specified config directory
- the
- a
config.${SERVICE_ENV}.jsonfile in the specified config directory,- where
SERVICE_ENVdefaults tolocal, if not set
- where
- a
config.default.jsonfile in the specified config directory
Example
config.local.json
{
"from": "file"
}
app.js
import { loadConfig } from 'snyk-config';
// as we're in the same directory as the config.local.json, there's no arg
const config = loadConfig();
console.log(config);
cli
$ SNYK_from=cli node app.js
=> { from: "cli" }
Notes
- Values read from the environment or from the process arguments will always be
stringsorbooleans. This is important to differentiate from values parsed in the config files as these can benumbers. - Environment property names strip off the preceding
SNYK_string, soSNYK_foo = 10becomesfoo = "10" - To create a nested object structure from the environment values, use two underscores:
SNYK_foo__bar = 10becomesfoo = { bar: "10" }
