officeparser 3.2.0 → 3.2.2

package/officeParser.js

@@ -506,7 +506,7 @@ function disableConsoleOutput() {
 /** Async function that can be used with await to execute parseWord. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
 var parseWordAsync = function (filename, deleteOfficeDist = true) {
     return new Promise((resolve, reject) => {
@@ -526,7 +526,7 @@ var parseWordAsync = function (filename, deleteOfficeDist = true) {
 /** Async function that can be used with await to execute parsePowerPoint. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
 var parsePowerPointAsync = function (filename, deleteOfficeDist = true) {
     return new Promise((resolve, reject) => {
@@ -546,7 +546,7 @@ var parsePowerPointAsync = function (filename, deleteOfficeDist = true) {
 /** Async function that can be used with await to execute parseExcel. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
 var parseExcelAsync = function (filename, deleteOfficeDist = true) {
     return new Promise((resolve, reject) => {
@@ -566,7 +566,7 @@ var parseExcelAsync = function (filename, deleteOfficeDist = true) {
 /** Async function that can be used with await to execute parseOpenOffice. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
 var parseOpenOfficeAsync = function (filename, deleteOfficeDist = true) {
     return new Promise((resolve, reject) => {
@@ -587,7 +587,7 @@ var parseOpenOfficeAsync = function (filename, deleteOfficeDist = true) {
  * Main async function that can be used with await to execute parseOffice. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
 var parseOfficeAsync = function (filename, deleteOfficeDist = true) {
     return new Promise((resolve, reject) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "officeparser",
-  "version": "3.2.0",
+  "version": "3.2.2",
   "description": "A Node.js library to parse text out of any office file. Currently supports docx, pptx, xlsx, odt, odp and ods files.",
   "main": "officeParser.js",
   "files": [
@@ -43,7 +43,7 @@
   "dependencies": {
     "decompress": "^4.2.0",
     "rimraf": "^2.6.3",
-    "xml2js": "^0.4.19"
+    "xml2js": "^0.5.0"
   },
   "devDependencies": {
     "typescript": "^5.0.3"

package/typings/officeParser.d.ts

@@ -6,7 +6,6 @@
  * @returns {void}
  */
 export function parseWord(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
-
 /** Main function for parsing text from PowerPoint files
  * @param {string} filename File path
  * @param {function} callback Callback function that returns value or error
@@ -14,7 +13,6 @@ export function parseWord(filename: string, callback: Function, deleteOfficeDist
  * @returns {void}
  */
 export function parsePowerPoint(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
-
 /** Main function for parsing text from Excel files
  * @param {string} filename File path
  * @param {function} callback Callback function that returns value or error
@@ -22,7 +20,6 @@ export function parsePowerPoint(filename: string, callback: Function, deleteOffi
  * @returns {void}
  */
 export function parseExcel(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
-
 /** Main function for parsing text from open office files
  * @param {string} filename File path
  * @param {function} callback Callback function that returns value or error
@@ -30,7 +27,6 @@ export function parseExcel(filename: string, callback: Function, deleteOfficeDis
  * @returns {void}
  */
 export function parseOpenOffice(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
-
 /** Main async function with callback to execute parseOffice for supported files
  * @param {string} filename File path
  * @param {function} callback Callback function that returns value or error
@@ -38,55 +34,47 @@ export function parseOpenOffice(filename: string, callback: Function, deleteOffi
  * @returns {void}
  */
 export function parseOffice(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
-
 /** Async function that can be used with await to execute parseWord. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
-export function parseWordAsync(filename: string, deleteOfficeDist?: boolean): void;
-
+export function parseWordAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
 /** Async function that can be used with await to execute parsePowerPoint. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
-export function parsePowerPointAsync(filename: string, deleteOfficeDist?: boolean): void;
-
+export function parsePowerPointAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
 /** Async function that can be used with await to execute parseExcel. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
-export function parseExcelAsync(filename: string, deleteOfficeDist?: boolean): void;
-
+export function parseExcelAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
 /** Async function that can be used with await to execute parseOpenOffice. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
-export function parseOpenOfficeAsync(filename: string, deleteOfficeDist?: boolean): void;
-
+export function parseOpenOfficeAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
 /**
  * Main async function that can be used with await to execute parseOffice. Or it can be used with promises.
  * @param {string} filename File path
  * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
+ * @returns {Promise<string>}
  */
-export function parseOfficeAsync(filename: string, deleteOfficeDist?: boolean): void;
-
+export function parseOfficeAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
 /**
  * Set decompression directory. The final decompressed data will be put inside officeDist folder within your directory
  * @param {string} newLocation Relative path to the directory that will contain officeDist folder with decompressed data
  * @returns {void}
  */
 export function setDecompressionLocation(newLocation: string): void;
-
 /** Enable console output
  * @returns {void}
  */
 export function enableConsoleOutput(): void;
-
 /** Disabled console output
  * @returns {void}
  */