From c2803e36881a91ed2f4ceecf6d55626433081d3a Mon Sep 17 00:00:00 2001 From: juergba Date: Tue, 29 Oct 2019 16:06:46 +0100 Subject: [PATCH] docu --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f1ccb98..6f052412 100644 --- a/README.md +++ b/README.md @@ -99,10 +99,12 @@ yargs engine. * `argv`: an object representing the parsed value of `args` * `key/value`: key value pairs for each argument and their aliases. * `_`: an array representing the positional arguments. + * [optional] `--`: an array with arguments after the end-of-options flag `--`. * `error`: populated with an error object if an exception occurred during parsing. * `aliases`: the inferred list of aliases built by combining lists in `opts.alias`. * `newAliases`: any new aliases added via camel-case expansion. -* `configuration`: the configuration loaded from the `yargs` stanza in package.json. +* `defaulted`: any new argument created by `opts.default`, no aliases included. +* `configuration`: given by the default settings and `opts.configuration`.