chore(tsconfig): use es2022 lib

Fdawgs · Oct 8, 2023 · 504bc84 · 504bc84
1 parent 99b59d7
commit 504bc84
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 4 deletions.
diff --git a/API.md b/API.md
@@ -5,6 +5,9 @@
 
 * [UnRTF](#UnRTF)
     * [new UnRTF([binPath])](#new_UnRTF_new)
+    * [.unrtfPath](#UnRTF+unrtfPath) : <code>string</code> \| <code>undefined</code>
+    * [.unrtfVersion](#UnRTF+unrtfVersion) : <code>string</code> \| <code>undefined</code>
+    * [.unrtfAcceptedOptions](#UnRTF+unrtfAcceptedOptions) : <code>object</code>
     * [.convert(file, [options])](#UnRTF+convert) ⇒ <code>Promise.&lt;string&gt;</code>
 
 <a name="new_UnRTF_new"></a>
@@ -13,8 +16,20 @@
 
 | Param | Type | Description |
 | --- | --- | --- |
-| [binPath] | <code>string</code> | Path of UnRTF binary. |
+| [binPath] | <code>string</code> | Path of UnRTF binary. If not provided, the constructor will attempt to find the binary in the PATH environment variable. For `win32`, a binary is bundled with the package and will be used if a local installation is not found. |
 
+<a name="UnRTF+unrtfPath"></a>
+
+### unRTF.unrtfPath : <code>string</code> \| <code>undefined</code>
+**Kind**: instance property of [<code>UnRTF</code>](#UnRTF)  
+<a name="UnRTF+unrtfVersion"></a>
+
+### unRTF.unrtfVersion : <code>string</code> \| <code>undefined</code>
+**Kind**: instance property of [<code>UnRTF</code>](#UnRTF)  
+<a name="UnRTF+unrtfAcceptedOptions"></a>
+
+### unRTF.unrtfAcceptedOptions : <code>object</code>
+**Kind**: instance property of [<code>UnRTF</code>](#UnRTF)  
 <a name="UnRTF+convert"></a>
 
 ### unRTF.convert(file, [options]) ⇒ <code>Promise.&lt;string&gt;</code>

diff --git a/tsconfig.json b/tsconfig.json
@@ -4,7 +4,7 @@
 		"checkJs": true,
 		"declaration": true,
 		"emitDeclarationOnly": true,
-		"lib": ["ES2023"],
+		"lib": ["ES2022"],
 		"module": "NodeNext",
 		"moduleResolution": "NodeNext",
 		"outDir": "types",

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,8 +1,20 @@
 export default UnRTF;
 export class UnRTF {
-	/** @param {string} [binPath] - Path of UnRTF binary. */
+	/**
+	 * @param {string} [binPath] - Path of UnRTF binary.
+	 * If not provided, the constructor will attempt to find the binary
+	 * in the PATH environment variable.
+	 *
+	 * For `win32`, a binary is bundled with the package and will be used
+	 * if a local installation is not found.
+	 */
 	constructor(binPath?: string);
-	unrtfPath: string;
+	/** @type {string|undefined} */
+	unrtfPath: string | undefined;
+	/** @type {string|undefined} */
+	unrtfVersion: string | undefined;
+	/** @type {object} */
+	unrtfAcceptedOptions: object;
 	/**
 	 * @author Frazer Smith
 	 * @description Converts an RTF file to HTML/LaTeX/RTF/TXT.