Add doc about second argument of convict (#348)

mozilla · Mar 6, 2020 · 7064166 · 7064166
1 parent 5dda475
commit 7064166
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/packages/convict/README.md b/packages/convict/README.md
@@ -383,11 +383,17 @@ convict.addParser({extension: 'json', parse: require('json5').parse});
 
 ## API
 
-### var config = convict(schema)
+### var config = convict(schema[, opts])
 
 `convict()` takes a schema object or a path to a schema JSON file and returns a
 convict configuration object.
 
+**opts:** Optional object:
+
+  - **opts.env**: Override `process.env` if specified using an object `{'NODE_ENV': 'production'}`.
+  - **opts.args**: Override `process.argv` if specified using an array `['--argname', 'value']` or
+  a string `--argname value`.
+
 The configuration object has an API for getting and setting values, described
 below.