node-xlsx

What is node-xlsx?

The node-xlsx package is a powerful tool for parsing and writing Excel files in Node.js. It allows you to read data from Excel files, manipulate it, and write it back to new Excel files. This package supports both .xlsx and .xls formats.

What are node-xlsx's main functionalities?

Reading Excel Files

This feature allows you to read data from an Excel file. The `parse` method reads the file and returns an array of worksheets, each containing an array of rows and columns.

const xlsx = require('node-xlsx');
const workSheetsFromFile = xlsx.parse(`${__dirname}/myFile.xlsx`);
console.log(workSheetsFromFile);

Writing Excel Files

This feature allows you to write data to an Excel file. The `build` method creates a buffer from the data, which can then be written to a file using Node's `fs` module.

const xlsx = require('node-xlsx');
const data = [[1, 2, 3], [4, 5, 6]];
const buffer = xlsx.build([{name: 'mySheetName', data: data}]);
require('fs').writeFileSync('myFile.xlsx', buffer);

Manipulating Excel Data

This feature allows you to manipulate data within an Excel file. You can read the file, modify the data, and then write the updated data back to a new file.

const xlsx = require('node-xlsx');
const workSheetsFromFile = xlsx.parse(`${__dirname}/myFile.xlsx`);
workSheetsFromFile[0].data[0][0] = 'New Value';
const buffer = xlsx.build(workSheetsFromFile);
require('fs').writeFileSync('myFile.xlsx', buffer);

Other packages similar to node-xlsx

xlsx

The xlsx package is another popular library for reading and writing Excel files in Node.js. It offers a wide range of features and is known for its performance and reliability. Compared to node-xlsx, it has a more extensive API and better documentation.

exceljs

The exceljs package provides a comprehensive set of features for working with Excel files, including support for styling, formatting, and creating complex worksheets. It is more feature-rich compared to node-xlsx, especially in terms of formatting and styling capabilities.

sheetjs

The sheetjs package, also known as js-xlsx, is a highly versatile library for parsing and writing spreadsheet files. It supports a wide range of formats and offers extensive functionality for data manipulation. It is comparable to node-xlsx but offers more flexibility and support for different file formats.

README

node-xlsx

Excel parser/builder that relies on xlsx.js (Microsoft Office Extensible File License), this package had to be released under the same restrictive license. Please read it carefully.

Quick start

Parsing a xlsx from file/buffer

var xlsx = require('node-xlsx');

var obj = xlsx.parse(__dirname + '/myFile.xlsx'); // parses a file

var obj = xlsx.parse(fs.readFileSync(__dirname + '/myFile.xlsx')); // parses a buffer

Building a plist from an object

var xlsx = require('node-xlsx');

var buffer = xlsx.build({worksheets: [
  {"name":"mySheetName", "data":[
    ["A1", "B1"],
    [
      {"value":"A2","formatCode":"General"},
      {"value":"B2","formatCode":"General"}
    ]
  ]}
]}); // returns a buffer

Testing

node-xlsx is tested with nodeunit.

npm install --dev

npm test

Contributing

Please submit all pull requests the against master branch. If your unit test contains javascript patches or features, you should include relevant unit tests. Thanks!

Authors

Olivier Louvignes

• http://olouv.com
• http://github.com/mgcrea

Copyright and license

This license governs use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software.

1. Definitions The terms "reproduce," "reproduction," "derivative works," and "distribution" have the same meaning here as under U.S. copyright law. A "contribution" is the original software, or any additions or changes to the software. A "contributor" is any person that distributes its contribution under this license. "Licensed patents" are a contributor's patent claims that read directly on its contribution. "Excluded Products” are software products or components, or web-based or hosted services, that primarily perform the same general functions as any of the following software applications: Microsoft Office, Word, Excel, PowerPoint, Outlook, OneNote, Publisher, SharePoint, or Access.

2. Grant of Rights (A) Copyright Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free copyright license to reproduce its contribution, prepare derivative works of its contribution, and distribute its contribution or any derivative works that you create. (B) Patent Grant- Subject to the terms of this license, including the license conditions and limitations in section 3, each contributor grants you a non-exclusive, worldwide, royalty-free license under its licensed patents to make, have made, use, sell, offer for sale, import, and/or otherwise dispose of its contribution in the software or derivative works of the contribution in the software.

3. Conditions and Limitations (A) No Trademark License- This license does not grant you rights to use any contributors' name, logo, or trademarks. (B) If you bring a patent claim against any contributor over patents that you claim are infringed by the software, your patent license from such contributor to the software ends automatically. (C) If you distribute any portion of the software, you must retain all copyright, patent, trademark, and attribution notices that are present in the software. (D) If you distribute any portion of the software in source code form, you may do so only under this license by including a complete copy of this license with your distribution. If you distribute any portion of the software in compiled or object code form, you may only do so under a license that complies with this license. (E) The software is licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the contributors exclude the implied warranties of merchantability, fitness for a particular purpose and non-infringement. (F) Platform Limitation- The licenses granted in sections 2(A) & 2(B) extend only to the software or derivative works that (1) are run on a Microsoft Windows operating system product, and (2) are not Excluded Products.