diff options
Diffstat (limited to 'std/flags')
| -rw-r--r-- | std/flags/README.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/std/flags/README.md b/std/flags/README.md index ebfc346e1..80b05549d 100644 --- a/std/flags/README.md +++ b/std/flags/README.md @@ -1,6 +1,6 @@ # flags -Command line arguments parser for Deno based on minimist +Command line arguments parser for Deno based on minimist. # Example @@ -42,15 +42,15 @@ Any arguments after `'--'` will not be parsed and will end up in `parsedArgs._`. options can be: - `options.string` - a string or array of strings argument names to always treat - as strings + as strings. - `options.boolean` - a boolean, string or array of strings to always treat as booleans. if `true` will treat all double hyphenated arguments without equal - signs as boolean (e.g. affects `--foo`, not `-f` or `--foo=bar`) + signs as boolean (e.g. affects `--foo`, not `-f` or `--foo=bar`). - `options.alias` - an object mapping string names to strings or arrays of - string argument names to use as aliases -- `options.default` - an object mapping string argument names to default values + string argument names to use as aliases. +- `options.default` - an object mapping string argument names to default values. - `options.stopEarly` - when true, populate `parsedArgs._` with everything after - the first non-option + the first non-option. - `options['--']` - when true, populate `parsedArgs._` with everything before the `--` and `parsedArgs['--']` with everything after the `--`. Here's an example: |