Skip to content

docs: clean up README examples #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Dec 28, 2021
Merged

docs: clean up README examples #23

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
29f7cf3
Clean up examples:
shadowspawn Dec 21, 2021
9066676
Rename variable to more conventional name
shadowspawn Dec 21, 2021
587cea0
Merge remote-tracking branch 'upstream/main' into feature/examples-wi…
shadowspawn Dec 22, 2021
137002f
Make "short" example self-consistent
shadowspawn Dec 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,23 +97,23 @@ const { parseArgs } = require('util')
```

```js
// default
const argv = ['-f', '--foo=a', '--foo', 'b']
// unconfigured
const argv = ['-f', '--foo=a', '--bar', 'b']
const options = {}
const { flags, values, positionals } = parseArgs(argv, options)
flags // { f: true, foo: true}
values // { f: [undefined], foo: [undefined] }
flags // { f: true, bar: true }
values // { foo: 'a' }
positionals // ['b']
```
```js
// withValue
const argv = ['-f', '--foo=a', '--foo', 'b']
const argv = ['-f', '--foo=a', '--bar', 'b']
const options = {
withValue: ['foo']
withValue: ['bar']
}
const { flags, values, positionals } = parseArgs(argv, options)
flags // { f: true, foo: true}
values // { f: [undefined], foo: ['b'] }
flags // { f: true }
values // { foo: 'a', bar: 'b' }
positionals // []
```
```js
Expand All @@ -124,19 +124,19 @@ const options = {
multiples: ['foo']
}
const { flags, values, positionals } = parseArgs(argv, options)
flags // { f: true, foo: true}
values // { f: [undefined], foo: ['a','b'] }
flags // { f: true }
values // { foo: ['a', 'b'] }
positionals // []
```
```js
// shorts
const argv = ['-f', '--foo=a', '--foo', 'b']
const argv = ['-f', 'b']
const options = {
short: { f: 'foo' }
}
const { flags, values, positionals } = parseArgs(argv, options)
flags // { foo: true}
values // { foo: [undefined] }
flags // { foo: true }
values // {}
positionals // ['b']
```

Expand Down