diff --git a/API.md b/API.md index e1a23da5..a5fdf9e7 100644 --- a/API.md +++ b/API.md @@ -8,7 +8,7 @@ ## Functions
-
parseOptions(acceptedOptions, [options])Promise.<(string|Error)>
+
parseOptions(acceptedOptions, options)Promise.<(Array|Error)>

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

@@ -445,15 +445,15 @@ one PDF result file. -## parseOptions(acceptedOptions, [options]) ⇒ Promise.<(string\|Error)> +## parseOptions(acceptedOptions, options) ⇒ Promise.<(Array\|Error)> Check each option provided is valid and of the correct type. **Kind**: global function -**Returns**: Promise.<(string\|Error)> - Promise of stdout string on resolve, or Error object on rejection. +**Returns**: Promise.<(Array\|Error)> - Promise of array of CLI arguments on resolve, or Error object on rejection. **Author**: Frazer Smith | Param | Type | Description | | --------------- | ------------------- | ------------------------------------------------ | | acceptedOptions | object | Object containing options that a binary accepts. | -| [options] | object | Object containing options to pass to binary. | +| options | object | Object containing options to pass to binary. | diff --git a/src/index.js b/src/index.js index 10acdad3..3047c361 100644 --- a/src/index.js +++ b/src/index.js @@ -10,8 +10,8 @@ const platform = os.platform(); * @author Frazer Smith * @description Check each option provided is valid and of the correct type. * @param {object} acceptedOptions - Object containing options that a binary accepts. - * @param {object=} options - Object containing options to pass to binary. - * @returns {Promise} Promise of stdout string on resolve, or Error object on rejection. + * @param {object} options - Object containing options to pass to binary. + * @returns {Promise} Promise of array of CLI arguments on resolve, or Error object on rejection. */ function parseOptions(acceptedOptions, options) { return new Promise((resolve, reject) => {