Skip to content

Commit 7076237

Browse files
committed
update links to docs
1 parent 4da0aac commit 7076237

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $ example -vt 1000 --src one.js two.js
2020
$ example -vt 1000 one.js two.js
2121
```
2222

23-
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.
23+
To access the values, first create a list of [option definitions](https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md) describing the options your application accepts. The [`type`](https://github.com/75lb/command-line-args/blob/master/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.
2424

2525
```js
2626
const optionDefinitions = [
@@ -30,7 +30,7 @@ const optionDefinitions = [
3030
]
3131
```
3232

33-
Next, parse the options using [commandLineArgs()](https://github.com/75lb/command-line-args/blob/next/doc/API.md#commandlineargsoptiondefinitions-options--object-):
33+
Next, parse the options using [commandLineArgs()](https://github.com/75lb/command-line-args/blob/master/doc/API.md#commandlineargsoptiondefinitions-options--object-):
3434
```js
3535
const commandLineArgs = require('command-line-args')
3636
const options = commandLineArgs(optionDefinitions)

doc/API.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
### commandLineArgs(optionDefinitions, [options]) ⇒ <code>object</code> ⏏
77
Returns an object containing all option values set on the command line. By default it parses the global [`process.argv`](https://nodejs.org/api/process.html#process_process_argv) array.
88

9-
Parsing is strict by default - an exception is thrown if the user sets an unknown value or option (one without a valid [definition](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md)). To be more permissive, enabling [partial mode](https://github.com/75lb/command-line-args/wiki/Partial-mode-example) will return known options as usual and return unknown arguments in a separate `_unknown` property.
9+
Parsing is strict by default - an exception is thrown if the user sets an unknown value or option (one without a valid [definition](https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md)). To be more permissive, enabling [partial mode](https://github.com/75lb/command-line-args/wiki/Partial-mode-example) will return known options as usual and return unknown arguments in a separate `_unknown` property.
1010

1111
**Kind**: Exported function
1212
**Throws**:
@@ -26,7 +26,7 @@ Parsing is strict by default - an exception is thrown if the user sets an unknow
2626

2727
| Param | Type | Description |
2828
| --- | --- | --- |
29-
| optionDefinitions | <code>Array.&lt;module:definition&gt;</code> | An array of [OptionDefinition](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md) objects |
29+
| optionDefinitions | <code>Array.&lt;module:definition&gt;</code> | An array of [OptionDefinition](https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md) objects |
3030
| [options] | <code>object</code> | Options. |
3131
| [options.argv] | <code>Array.&lt;string&gt;</code> | An array of strings which, if present will be parsed instead of `process.argv`. |
3232
| [options.partial] | <code>boolean</code> | If `true`, an array of unknown arguments is returned in the `_unknown` property of the output. |

index.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ module.exports = commandLineArgs
88
/**
99
* Returns an object containing all option values set on the command line. By default it parses the global [`process.argv`](https://nodejs.org/api/process.html#process_process_argv) array.
1010
*
11-
* Parsing is strict by default - an exception is thrown if the user sets an unknown value or option (one without a valid [definition](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md)). To be more permissive, enabling [partial mode](https://github.com/75lb/command-line-args/wiki/Partial-mode-example) will return known options as usual and return unknown arguments in a separate `_unknown` property.
11+
* Parsing is strict by default - an exception is thrown if the user sets an unknown value or option (one without a valid [definition](https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md)). To be more permissive, enabling [partial mode](https://github.com/75lb/command-line-args/wiki/Partial-mode-example) will return known options as usual and return unknown arguments in a separate `_unknown` property.
1212
*
13-
* @param {module:definition[]} - An array of [OptionDefinition](https://github.com/75lb/command-line-args/blob/next/doc/option-definition.md) objects
13+
* @param {module:definition[]} - An array of [OptionDefinition](https://github.com/75lb/command-line-args/blob/master/doc/option-definition.md) objects
1414
* @param {object} [options] - Options.
1515
* @param {string[]} [options.argv] - An array of strings which, if present will be parsed instead of `process.argv`.
1616
* @param {boolean} [options.partial] - If `true`, an array of unknown arguments is returned in the `_unknown` property of the output.

0 commit comments

Comments
 (0)