officeParser

一个用于从任何Office文件中解析文本的Node.js库。

支持的文件类型

更新

2024/05/06 - 将pdf解析支持从pdf-parse库替换为使用Mozilla的pdf.js库原生构建，通过分析其输出。将pdfjs-dist构建添加为本地库。
2023/11/25 - 修复了在解析文件时发生错误的捕获，特别是在解压文件后。同时修复了并行解析文件的问题，因为我们之前仅使用时间戳作为文件名。
2023/10/24 - 重新设计了内容解析代码。修复了文件中内容的顺序，特别是在Word文件中，表格信息总是出现在文本末尾的问题。为parseOffice函数添加了配置对象参数，可用于设置新行分隔符和多个其他配置。使用流行的npm库pdf-parse添加了对解析pdf文件的支持。移除了对单独文件解析函数的支持。
2023/04/26 - 为parseOffice和parseOfficeAsync的filepath参数添加了文件缓冲区支持
2023/04/07 - 为方法添加了类型定义，以帮助Typescript项目。
2022/12/28 - 添加了命令行方法，可以在安装或不安装officeParser的情况下使用，并立即在控制台获取解析内容。
2022/12/10 - 修复了内存泄漏问题，解析开放文档文件相关的bug，并改进了错误处理。
2021/11/21 - 为现有的回调函数添加了Promise方式。
2020/06/01 - 添加了错误处理和控制台日志启用/禁用方法。默认设置为启用。所有功能向后兼容。
2019/06/17 - 添加了更改解压Office文件位置的方法，适用于写入访问受限的地方。
2019/04/30 - 移除了大小写敏感的文件扩展名bug。现在支持带大写字母扩展名的文件名。
2019/04/23 - 通过parseOffice函数添加了对开放办公文件*.odt、.odp、.ods的支持。为喜欢使用目标函数的用户创建了新的parseOpenOffice方法。
2019/04/23 - 添加了在函数回调后删除生成的dist文件夹的功能。
2019/04/22 - 添加了parseOffice方法，以避免文件类型和扩展名之间的混淆。
2019/04/22 - 添加了文件扩展名验证。移除了对没有绘图元素的Excel文件的错误。
2019/04/19 - 添加了对*.xlsx文件的支持。
2019/04/18 - 添加了对*.pptx文件的支持。

通过npm安装

npm i officeparser

命令行使用

如果要调用已安装的officeParser.js文件，使用以下命令

node </path/to/officeParser.js> <fileName>

或者，你可以简单地使用npx立即提取解析数据。

npx officeparser <fileName>

库使用

const officeParser = require('officeparser');

// 回调
officeParser.parseOffice("/path/to/officeFile", function(data, err) {
    // 这里回调中的"data"字符串是从上面第一个参数传入的office文件中解析出的文本
    if (err) {
        console.log(err);
        return;
    }
    console.log(data);
})

// Promise
officeParser.parseOfficeAsync("/path/to/officeFile");
// 这里Promise中的"data"字符串是从上面参数传入的office文件中解析出的文本
    .then(data => console.log(data))
    .catch(err => console.error(err))

// async/await
try {
    // 这里从Promise返回的"data"字符串是从参数传入的office文件中解析出的文本
    const data = await officeParser.parseOfficeAsync("/path/to/officeFile");
    console.log(data);
} catch (err) {
    // 解决错误
    console.log(err);
}

// 使用文件缓冲区
// 除了文件路径，你还可以传递支持文件类型之一的文件缓冲区
// 给parseOffice或parseOfficeAsync函数。

// 获取文件缓冲区
const fileBuffers = fs.readFileSync("/path/to/officeFile");
// 从officeParser获取解析后的文本
// 注意：仅适用于parseOffice。不支持旧函数。
officeParser.parseOfficeAsync(fileBuffers);
    .then(data => console.log(data))
    .catch(err => console.error(err))

配置对象：OfficeParserConfig

可以选择将配置对象作为第三个参数添加到parseOffice中，以实现以下配置

标志	数据类型	默认值	说明
tempFilesLocation	字符串	officeParserTemp	officeparser存储临时文件的目录。最终解压缩的数据将放在您目录中的officeParserTemp文件夹内。请确保该目录确实存在。默认值为officeParserTemp。
preserveTempFiles	布尔值	false	不删除解压缩办公文件后使用的内部内容文件和可能的重复临时文件的标志。默认为false。它总是会删除所有这些文件。
outputErrorToConsole	布尔值	false	在出错时将所有日志显示到控制台的标志。默认为false。
newlineDelimiter	字符串	\n	用于允许多行文本（如Word）的地方的每个新行的分隔符。默认为\n。
ignoreNotes	布尔值	false	忽略解析PowerPoint等文件中的注释的标志。默认为false。默认情况下，它会在解析的文本中包含注释。
putNotesAtLast	布尔值	false	如果设置为true，将在PowerPoint等文件中将所有从注释解析的文本集中放在最后。默认为false。它会将每个注释直接放在其主幻灯片内容之后。如果ignoreNotes设置为true，则此标志也会被忽略。

<br>

const config = {
    newlineDelimiter: " ",  // 用空格而不是默认的\n分隔新行。
    ignoreNotes: true       // 解析pptx或odp等演示文件时忽略注释。
}

// 回调
officeParser.parseOffice("/path/to/officeFile", function(data, err){
    if (err) {
        console.log(err);
        return;
    }
    console.log(data);
}, config)

// Promise
officeParser.parseOfficeAsync("/path/to/officeFile", config);
    .then(data => console.log(data))
    .catch(err => console.error(err))

示例 - JavaScript

const officeParser = require('officeparser');

const config = {
    newlineDelimiter: " ",  // 用空格而不是默认的\n分隔新行。
    ignoreNotes: true       // 解析pptx或odp等演示文件时忽略注释。
}

// 相对路径也可以 => 例如：files/myWorkSheet.ods
officeParser.parseOfficeAsync("/Users/harsh/Desktop/files/mySlides.pptx", config);
    .then(data => {
        const newText = data + " 看，我可以解析PowerPoint文件";
        callSomeOtherFunction(newText);
    })
    .catch(err => console.error(err));

// 在解析的文本中搜索术语。
function searchForTermInOfficeFile(searchterm, filepath) {
    return officeParser.parseOfficeAsync(filepath)
        .then(data => data.indexOf(searchterm) != -1)
}

示例 - TypeScript

const officeParser = require('officeparser');

const config: OfficeParserConfig = {
    newlineDelimiter: " ",  // 用空格而不是默认的\n分隔新行。
    ignoreNotes: true       // 解析pptx或odp等演示文件时忽略注释。
}

// 相对路径也可以 => 例如：files/myWorkSheet.ods
officeParser.parseOfficeAsync("/Users/harsh/Desktop/files/mySlides.pptx", config);
    .then(data => {
        const newText = data + " 看，我可以解析PowerPoint文件";
        callSomeOtherFunction(newText);
    })
    .catch(err => console.error(err));

// 在解析的文本中搜索术语。
function searchForTermInOfficeFile(searchterm: string, filepath: string): Promise<boolean> {
    return officeParser.parseOfficeAsync(filepath)
        .then(data => data.indexOf(searchterm) != -1)
}