diff options
Diffstat (limited to 'node_modules/yargs-parser/README.md')
| -rw-r--r-- | node_modules/yargs-parser/README.md | 26 |
1 files changed, 2 insertions, 24 deletions
diff --git a/node_modules/yargs-parser/README.md b/node_modules/yargs-parser/README.md index 5f1ccb987..dde9f84d1 100644 --- a/node_modules/yargs-parser/README.md +++ b/node_modules/yargs-parser/README.md @@ -31,7 +31,7 @@ node example.js --foo=33 --bar hello _or parse a string!_ ```js -var argv = require('yargs-parser')('--foo=99 --bar=33') +var argv = require('./')('--foo=99 --bar=33') console.log(argv) ``` @@ -370,7 +370,7 @@ node example.js --test-field 1 * key: `strip-dashed` Should dashed keys be removed before returning results? This option has no effect if -`camel-case-expansion` is disabled. +`camel-case-exansion` is disabled. _If disabled:_ @@ -386,28 +386,6 @@ node example.js --test-field 1 { _: [], testField: 1 } ``` -### unknown options as args - -* default: `false` -* key: `unknown-options-as-args` - -Should unknown options be treated like regular arguments? An unknown option is one that is not -configured in `opts`. - -_If disabled_ - -```sh -node example.js --unknown-option --known-option 2 --string-option --unknown-option2 -{ _: [], unknownOption: true, knownOption: 2, stringOption: '', unknownOption2: true } -``` - -_If enabled_ - -```sh -node example.js --unknown-option --known-option 2 --string-option --unknown-option2 -{ _: ['--unknown-option'], knownOption: 2, stringOption: '--unknown-option2' } -``` - ## Special Thanks The yargs project evolves from optimist and minimist. It owes its |