chore(index): add throw jsdoc tags; add type guards to tests (#491)

Author: Fdawgs

API.md

@@ -5,6 +5,13 @@
 <dd></dd>
 </dl>
 
+## Constants
+
+<dl>
+<dt><a href="#ERROR_MSGS">ERROR_MSGS</a> : <code>Record.&lt;string, string&gt;</code></dt>
+<dd></dd>
+</dl>
+
 ## Typedefs
 
 <dl>
@@ -33,6 +40,10 @@
 <a name="new_UnRTF_new"></a>
 
 ### new UnRTF([binPath])
+**Throws**:
+
+- <code>Error</code> If UnRTF binary cannot be found or version cannot be determined.
+
 
 | Param | Type | Description |
 | --- | --- | --- |
@@ -61,6 +72,10 @@ UnRTF will use the directory of the original file to store embedded pictures.
 
 **Kind**: instance method of [<code>UnRTF</code>](#UnRTF)  
 **Returns**: <code>Promise.&lt;string&gt;</code> - A promise that resolves with a stdout string, or rejects with an `Error` object.  
+**Throws**:
+
+- <code>Error</code> If the file is missing, not an RTF file, or if UnRTF returns an error.
+
 **Author**: Frazer Smith  
 
 | Param | Type | Description |
@@ -72,6 +87,10 @@ UnRTF will use the directory of the original file to store embedded pictures.
 
 ### UnRTF.UnRTF : <code>string</code> \| <code>undefined</code>
 **Kind**: static property of [<code>UnRTF</code>](#UnRTF)  
+<a name="ERROR_MSGS"></a>
+
+## ERROR\_MSGS : <code>Record.&lt;string, string&gt;</code>
+**Kind**: global constant  
 <a name="OptionDetails"></a>
 
 ## OptionDetails : <code>object</code>

src/index.js

@@ -6,6 +6,7 @@ const { normalize, resolve: pathResolve } = require("node:path");
 const { platform } = require("node:process");
 const { gt, lt } = require("semver");
 
+/** @type {Record<string, string>} */
 const ERROR_MSGS = {
 	3221225477: "Segmentation fault",
 };
@@ -53,10 +54,10 @@ const UNRTF_VERSION_REG = /^(\d{1,2}\.\d{1,2}\.\d{1,2})/u;
  * version of binary.
  * @ignore
  * @param {UnRTFAcceptedOptions} acceptedOptions - Object containing accepted options.
- * @param {Record<string, any>} options - Object containing options to pass to binary.
+ * @param {UnRTFOptions} options - Object containing options to pass to binary.
  * @param {string} version - Semantic version of binary.
  * @returns {string[]} Array of CLI arguments.
- * @throws If invalid arguments provided.
+ * @throws {Error} If invalid arguments provided.
  */
 function parseOptions(acceptedOptions, options, version) {
 	/** @type {string[]} */
@@ -167,6 +168,7 @@ class UnRTF {
 	 *
 	 * For `win32`, a binary is bundled with the package and will be used
 	 * if a local installation is not found.
+	 * @throws {Error} If UnRTF binary cannot be found or version cannot be determined.
 	 */
 	constructor(binPath) {
 		this.#unrtfPath = "";
@@ -241,6 +243,7 @@ class UnRTF {
 	 * @param {string} file - Filepath of the RTF file to read.
 	 * @param {UnRTFOptions} [options] - Options to pass to UnRTF binary.
 	 * @returns {Promise<string>}  A promise that resolves with a stdout string, or rejects with an `Error` object.
+	 * @throws {Error} If the file is missing, not an RTF file, or if UnRTF returns an error.
 	 */
 	async convert(file, options = {}) {
 		let normalizedFile;
@@ -303,8 +306,7 @@ class UnRTF {
 				} else if (stdErr === "") {
 					reject(
 						new Error(
-							// @ts-ignore: Second operand used if code is not in ERROR_MSGS
-							ERROR_MSGS[code] ||
+							ERROR_MSGS[code ?? -1] ||
 								`unrtf ${args.join(
 									" "
 								)} exited with code ${code}`

src/index.test.js

@@ -47,6 +47,10 @@ function getTestBinaryPath() {
 		unrtfPath = join(__dirname, "lib", "win32", "unrtf-0.19.3", "bin");
 	}
 
+	if (!unrtfPath) {
+		throw new Error(`Unable to find ${platform} UnRTF binaries.`);
+	}
+
 	return normalize(unrtfPath);
 }
 
@@ -90,9 +94,11 @@ describe("Node-UnRTF module", () => {
 				// eslint-disable-next-line no-unused-vars -- This is intentional
 				const unRtf = new UnRTFMock();
 			} catch (err) {
-				expect(err.message).toBe(
-					`Unable to find ${mockPlatform} UnRTF binaries, please pass the installation directory as a parameter to the UnRTF instance.`
-				);
+				if (err instanceof Error) {
+					expect(err.message).toBe(
+						`Unable to find ${mockPlatform} UnRTF binaries, please pass the installation directory as a parameter to the UnRTF instance.`
+					);
+				}
 			}
 		});
 
@@ -115,22 +121,32 @@ describe("Node-UnRTF module", () => {
 				// eslint-disable-next-line no-unused-vars -- This is intentional
 				const unRtf = new UnRTFMock();
 			} catch (err) {
-				expect(err.message).toBe("Unable to determine UnRTF version.");
+				if (err instanceof Error) {
+					expect(err.message).toBe(
+						"Unable to determine UnRTF version."
+					);
+				}
 			}
 		});
 	});
 
 	const unRtf = new UnRTF(testBinaryPath);
 
 	describe("Convert function", () => {
+		/** @type {string} */
 		let version;
 
 		beforeAll(async () => {
 			const { stderr } = await execFileAsync(
 				join(testBinaryPath, "unrtf"),
 				["--version"]
 			);
-			version = /^(\d{1,2}\.\d{1,2}\.\d{1,2})/u.exec(stderr)[1];
+
+			const match = /^(\d{1,2}\.\d{1,2}\.\d{1,2})/u.exec(stderr);
+			if (!match?.[1]) {
+				throw new Error("Unable to parse UnRTF version from stderr");
+			}
+			version = match[1];
 		});
 
 		it("Converts RTF if any valid options are set", async () => {
@@ -302,6 +318,7 @@ describe("Node-UnRTF module", () => {
 			"Rejects with an Error object if $testName",
 			async ({ filePath, options, expError }) => {
 				await expect(
+					// @ts-expect-error: Testing invalid parameters being passed
 					unRtf.convert(filePath, {
 						noPictures: true,
 						...options,