From 59bb581253f6d1baa308e136dac4ddb034486011 Mon Sep 17 00:00:00 2001
From: Frazer Smith <frazer.smith@ydh.nhs.uk>
Date: Tue, 10 Nov 2020 12:44:26 +0000
Subject: [PATCH] docs(index): correct return jsdoc tag for parseoptions
 function

---
 API.md       | 8 ++++----
 src/index.js | 4 ++--
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/API.md b/API.md
index 624f5d7..0017f3b 100644
--- a/API.md
+++ b/API.md
@@ -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>
@@ -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.     |
diff --git a/src/index.js b/src/index.js
index d6f26d6..6d0fd85 100644
--- a/src/index.js
+++ b/src/index.js
@@ -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) => {