Skip to content

Commit

Permalink
docs(index): correct return jsdoc tag for parseoptions function
Browse files Browse the repository at this point in the history
  • Loading branch information
Frazer Smith committed Nov 10, 2020
1 parent dd1084e commit 59bb581
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
8 changes: 4 additions & 4 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
## Functions

<dl>
<dt><a href="#parseOptions">parseOptions(options, acceptedOptions)</a> ⇒ <code>Promise.&lt;(string|Error)&gt;</code></dt>
<dt><a href="#parseOptions">parseOptions(acceptedOptions, options)</a> ⇒ <code>Promise.&lt;(Array|Error)&gt;</code></dt>
<dd><p>Check each option provided is valid and of the correct type.</p>
</dd>
</dl>
Expand Down Expand Up @@ -60,15 +60,15 @@ UnRTF will use the directory of the original file to store embedded pictures.

<a name="parseOptions"></a>

## parseOptions(options, acceptedOptions) ⇒ <code>Promise.&lt;(string\|Error)&gt;</code>
## parseOptions(acceptedOptions, options) ⇒ <code>Promise.&lt;(Array\|Error)&gt;</code>

Check each option provided is valid and of the correct type.

**Kind**: global function
**Returns**: <code>Promise.&lt;(string\|Error)&gt;</code> - Promise of stdout string on resolve, or Error object on rejection.
**Returns**: <code>Promise.&lt;(Array\|Error)&gt;</code> - Promise of array of CLI arguments on resolve, or Error object on rejection.
**Author**: Frazer Smith

| Param | Type | Description |
| --------------- | ------------------- | ------------------------------------------------ |
| options | <code>object</code> | Object containing options to pass to binary. |
| acceptedOptions | <code>object</code> | Object containing options that a binary accepts. |
| options | <code>object</code> | Object containing options to pass to binary. |
4 changes: 2 additions & 2 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ const platform = os.platform();
/**
* @author Frazer Smith
* @description Check each option provided is valid and of the correct type.
* @param {object} options - Object containing options to pass to binary.
* @param {object} acceptedOptions - Object containing options that a binary accepts.
* @returns {Promise<string|Error>} Promise of stdout string on resolve, or Error object on rejection.
* @param {object} options - Object containing options to pass to binary.
* @returns {Promise<Array|Error>} Promise of array of CLI arguments on resolve, or Error object on rejection.
*/
function parseOptions(acceptedOptions, options) {
return new Promise((resolve, reject) => {
Expand Down

0 comments on commit 59bb581

Please sign in to comment.