Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
75lb committed Jan 17, 2018
1 parent 7b8f7bf commit 64f2120
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ example -vt 1000 --src one.js two.js
$ example -vt 1000 one.js two.js
```

To access the values, first create a list of [option definitions](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md) describing your accepted options. The [`type`](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md#optiontype--function) property is a setter function (the value supplied is passed through this), giving you full control over the value received.
To access the values, first create a list of [option definitions](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md) describing the options your application accepts. The [`type`](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md#optiontype--function) property is a setter function (the value supplied is passed through this), giving you full control over the value received.

```js
const optionDefinitions = [
Expand Down
2 changes: 1 addition & 1 deletion doc/option-definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ const optionDefinitions = [
#### option.type : <code>function</code>
The `type` value is a setter function (you receive the output from this), enabling you to be specific about the type and value received.

The most common values used are `String`, `Number` and `Boolean` but you can use a custom function, if you like:
The most common values used are `String`, `Number` and `Boolean` but you can use a custom function, for example:

```js
const fs = require('fs')
Expand Down
2 changes: 1 addition & 1 deletion lib/option-definition.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class OptionDefinition {
/**
* The `type` value is a setter function (you receive the output from this), enabling you to be specific about the type and value received.
*
* The most common values used are `String`, `Number` and `Boolean` but you can use a custom function, if you like:
* The most common values used are `String`, `Number` and `Boolean` but you can use a custom function, for example:
*
* ```js
* const fs = require('fs')
Expand Down

0 comments on commit 64f2120

Please sign in to comment.