Skip to content

Commit

Permalink
documented argv['--']
Browse files Browse the repository at this point in the history
  • Loading branch information
James Halliday committed May 12, 2014
1 parent 715c1e3 commit 14db0e6
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions readme.markdown
Expand Up @@ -59,6 +59,17 @@ strings
* `opts.alias` - an object mapping string names to strings or arrays of string
argument names to use as aliases
* `opts.default` - an object mapping string argument names to default values
* `opts['--']` - when true, populate `argv._` with everything before the `--`
and `argv['--']` with everything after the `--`. Here's an example:

```
> require('./')('one two three -- four five --six'.split(' '), { '--': true })
{ _: [ 'one', 'two', 'three' ],
'--': [ 'four', 'five', '--six' ] }
```

Note that with `opts['--']` set, parsing for arguments still stops after the
`--`.

# install

Expand Down

0 comments on commit 14db0e6

Please sign in to comment.