We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 5dda475 commit 7064166Copy full SHA for 7064166
packages/convict/README.md
@@ -383,11 +383,17 @@ convict.addParser({extension: 'json', parse: require('json5').parse});
383
384
## API
385
386
-### var config = convict(schema)
+### var config = convict(schema[, opts])
387
388
`convict()` takes a schema object or a path to a schema JSON file and returns a
389
convict configuration object.
390
391
+**opts:** Optional object:
392
+
393
+ - **opts.env**: Override `process.env` if specified using an object `{'NODE_ENV': 'production'}`.
394
+ - **opts.args**: Override `process.argv` if specified using an array `['--argname', 'value']` or
395
+ a string `--argname value`.
396
397
The configuration object has an API for getting and setting values, described
398
below.
399
0 commit comments