Merge pull request #281 from Fdawgs/fix/defaults

API.md

@@ -19,6 +19,7 @@
 
 ### unRTF.convert(file, [options]) ⇒ <code>Promise.&lt;(string\|Error)&gt;</code>
 Converts an RTF file to HTML/LaTeX/RTF/TXT.
+Defaults to HTML output if no `output*` options are provided.
 UnRTF will use the directory of the original file to store embedded pictures.
 
 **Kind**: instance method of [<code>UnRTF</code>](#UnRTF)  

src/index.js

@@ -24,6 +24,10 @@ function parseOptions(acceptedOptions, options, version) {
 		if (Object.prototype.hasOwnProperty.call(acceptedOptions, key)) {
 			// eslint-disable-next-line valid-typeof
 			if (typeof options[key] === acceptedOptions[key].type) {
+				// Skip boolean options if false
+				if (acceptedOptions[key].type === "boolean" && !options[key]) {
+					return;
+				}
 				args.push(acceptedOptions[key].arg);
 			} else {
 				invalidArgs.push(
@@ -89,6 +93,7 @@ class UnRTF {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts an RTF file to HTML/LaTeX/RTF/TXT.
+	 * Defaults to HTML output if no `output*` options are provided.
 	 * UnRTF will use the directory of the original file to store embedded pictures.
 	 * @param {string} file - Filepath of the RTF file to read.
 	 * @param {object=} options - Object containing options to pass to binary.

src/index.test.js

@@ -96,6 +96,30 @@ describe("Convert function", () => {
 		expect(isHtml(res)).toBe(true);
 	});
 
+	it("Converts RTF file to HTML if the `output*` option is set to false", async () => {
+		const outputOptions = [
+			"outputHtml",
+			"outputLatex",
+			"outputText",
+			"outputVt",
+		];
+
+		const unRtf = new UnRTF(testBinaryPath);
+
+		await Promise.all(
+			outputOptions.map(async (option) => {
+				const options = {
+					noPictures: true,
+					[option]: false,
+				};
+
+				const res = await unRtf.convert(file, options);
+
+				expect(isHtml(res)).toBe(true);
+			})
+		);
+	});
+
 	it("Converts RTF file to HTML without storing images", async () => {
 		const unRtf = new UnRTF(testBinaryPath);
 		const options = {

types/index.d.ts

@@ -8,6 +8,7 @@ export class UnRTF {
 	/**
 	 * @author Frazer Smith
 	 * @description Converts an RTF file to HTML/LaTeX/RTF/TXT.
+	 * Defaults to HTML output if no `output*` options are provided.
 	 * UnRTF will use the directory of the original file to store embedded pictures.
 	 * @param {string} file - Filepath of the RTF file to read.
 	 * @param {object=} options - Object containing options to pass to binary.