npm 包 xlsx-readable 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，处理 Excel 文件是一项常见的任务。而 Excel 文件的读取、解析和转换却是一项颇为繁琐的操作。为了能够更方便快捷地处理 Excel 文件，前端开发者们开发了各种各样的工具库来辅助我们完成这项工作。其中一个比较好用的 npm 包就是 xlsx-readable。

本文将对 xlsx-readable 包进行详细的介绍和使用教程，帮助读者更好地掌握这一工具。

xlsx-readable 简介

xlsx-readable 是一个可以读取 Excel 文件的 npm 包。它可以将 Excel 文件读取成 JavaScript 数组或对象，并支持多种数据格式（如 xls, xlsx, csv, tsv）的解析。

xlsx-readable 的主要特点包括：

支持多种文件格式
支持大量数据量的读取
支持读取工作簿和单元格格式

xlsx-readable 安装

在使用 xlsx-readable 之前，需要先安装它。可以在终端中使用 npm 进行安装：

npm install xlsx-readable --save

xlsx-readable 使用方法

读取 Excel 文件

读取 Excel 文件需要使用 read 方法，该方法接收两个参数：文件路径和配置选项。

以下是一个简单的读取 Excel 文件的示例代码：

const xlsx = require('xlsx-readable');
const file = './example.xlsx';

xlsx.read(file)
    .then((sheets) => console.log(sheets))
    .catch((error) => console.log(error));

这个示例代码中，首先导入 xlsx-readable 包，然后指定需要读取的 Excel 文件路径。使用 read 方法读取 Excel 文件，并将返回的所有工作表数据存储在 sheets 变量中，最后使用 console.log 方法输出 sheets 变量。

配置选项

read 方法可以接收一个包含配置选项的对象参数。目前，xlsx-readable 支持以下的配置选项：

选项名	类型	默认值	描述
`sheet`	字符串	null	指定读取的工作表名称
`headers`	数组	[]	自定义读取到的表头
`output`	字符串	array	输出数据的格式，可选：array 或 object
`format`	字符串	null	指定输出的数据格式，可选：json 或 Ndjson
`numericDates`	布尔类型	false	将日期值解析为数字而非日期类型
`cellDates`	布尔类型	false	读取日期格式的单元格时保留日期数据类型
`dateNF`	字符串	null	格式化日期格式的选项
`parseFormula`	布尔类型	true	解析单元格中的公式
`password`	字符串	无	解析受密码保护的文件
`extendRows`	布尔类型	false	如果整个行都是空的话，将其忽略
`omitEmptyRows`	布尔类型	false	忽略整行都是空的行
`includeEmptyRows`	布尔类型	false	包括整行都是空的行

输出格式

xlsx-readable 的默认输出格式是数组格式。可以通过配置选项中的 output 来改变输出类型，支持两种输出格式：

array：输出数组格式。
object：输出对象格式。

内置过滤器

xlsx-readable 内置了几种过滤器，可用于对读取到的数据进行预处理。以下是几种常用的过滤器：

字段筛选

筛选指定的字段并返回，同时忽略不在筛选列表中的其他字段。

-- -------------------- ---- -------
------ ---- ---- ----------------

----- ---- - -----------------

----
  ----------- - -------- ---- --
  ------------ --
    ------------------------------------------- --------- ------
  -
  -------------------- -- --------------------------
  ------------ -- --------------------

值筛选

筛选指定的值并返回，忽略不在值列表中的其他值。

-- -------------------- ---- -------
------ ---- ---- ----------------

----- ---- - -----------------

----
  -----------
  ------------ --
    ---------------------------------------- --------- ----- ---
  -
  -------------------- -- --------------------------
  ------------ -- --------------------

处理多个工作表

xlsx-readable 支持读取 Excel 文件中的多个工作表，只需要在配置选项中指定需要读取的工作表即可。以下是一个简单的读取多个工作表的示例代码：

import xlsx from 'xlsx-readable';

const file = './example.xlsx';

xlsx
  .read(file, { sheet: ['Sheet1', 'Sheet2'] })
  .then((data) => console.log(data))
  .catch((err) => console.error(err));

这个示例代码中，配置选项中的 sheet 参数指定了需要读取的工作表，读取到的工作表数据将存储在 data 变量中。

总结

到这里，本文就对 xlsx-readable 包进行了详细的介绍和使用教程。通过本文的学习，读者可以深入了解 xlsx-readable 包的使用方法，并可以在实际开发中轻松应用它来读取、解析和转换 Excel 文件。

赶快下载 xlsx-readable 包，开始你的 Excel 文件处理之旅吧！

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600554dc81e8991b448d20f6