node-xlsx

Features

Straightforward excel file parser and builder.

• Relies on SheetJS xlsx module to parse/build excel sheets.
• Built with TypeScript for static type checking with exported types along the library.

Install

1npm install node-xlsx --save
2# or
3pnpm add node-xlsx

Quickstart

Parse an xlsx file

1import xlsx from 'node-xlsx';
2// Or var xlsx = require('node-xlsx').default;
3
4// Parse a buffer
5const workSheetsFromBuffer = xlsx.parse(fs.readFileSync(`${__dirname}/myFile.xlsx`));
6// Parse a file
7const workSheetsFromFile = xlsx.parse(`${__dirname}/myFile.xlsx`);

Build an xlsx file

1import xlsx from 'node-xlsx';
2// Or var xlsx = require('node-xlsx').default;
3
4const data = [
5  [1, 2, 3],
6  [true, false, null, 'sheetjs'],
7  ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'],
8  ['baz', null, 'qux'],
9];
10var buffer = xlsx.build([{name: 'mySheetName', data: data}]); // Returns a buffer

Custom column width

1import xlsx from 'node-xlsx';
2// Or var xlsx = require('node-xlsx').default;
3
4const data = [
5  [1, 2, 3],
6  [true, false, null, 'sheetjs'],
7  ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'],
8  ['baz', null, 'qux'],
9];
10const sheetOptions = {'!cols': [{wch: 6}, {wch: 7}, {wch: 10}, {wch: 20}]};
11
12var buffer = xlsx.build([{name: 'mySheetName', data: data}], {sheetOptions}); // Returns a buffer

Spanning multiple rows A1:A4 in every sheets

1import xlsx from 'node-xlsx';
2// Or var xlsx = require('node-xlsx').default;
3
4const data = [
5  [1, 2, 3],
6  [true, false, null, 'sheetjs'],
7  ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'],
8  ['baz', null, 'qux'],
9];
10const range = {s: {c: 0, r: 0}, e: {c: 0, r: 3}}; // A1:A4
11const sheetOptions = {'!merges': [range]};
12
13var buffer = xlsx.build([{name: 'mySheetName', data: data}], {sheetOptions}); // Returns a buffer

Spanning multiple rows A1:A4 in second sheet

1import xlsx from 'node-xlsx';
2// Or var xlsx = require('node-xlsx').default;
3
4const dataSheet1 = [
5  [1, 2, 3],
6  [true, false, null, 'sheetjs'],
7  ['foo', 'bar', new Date('2014-02-19T14:30Z'), '0.3'],
8  ['baz', null, 'qux'],
9];
10const dataSheet2 = [
11  [4, 5, 6],
12  [7, 8, 9, 10],
13  [11, 12, 13, 14],
14  ['baz', null, 'qux'],
15];
16const range = {s: {c: 0, r: 0}, e: {c: 0, r: 3}}; // A1:A4
17const sheetOptions = {'!merges': [range]};
18
19var buffer = xlsx.build([
20  {name: 'myFirstSheet', data: dataSheet1},
21  {name: 'mySecondSheet', data: dataSheet2, options: sheetOptions},
22]); // Returns a buffer

Beware that if you try to merge several times the same cell, your xlsx file will be seen as corrupted.

• Using Primitive Object Notation Data values can also be specified in a non-abstracted representation.

Examples:

1const rowAverage = [[{t: 'n', z: 10, f: '=AVERAGE(2:2)'}], [1, 2, 3]];
2var buffer = xlsx.build([{name: 'Average Formula', data: rowAverage}]);

Refer to xlsx documentation for valid structure and values:

• Format

Troubleshooting

This library requires at least node.js v10. For legacy versions, you can use this workaround before using the lib.

1npm i --save object-assign

1Object.prototype.assign = require('object-assign');

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!

Available scripts

Script	Description
start	Alias of test:watch
test	Run mocha unit tests
test:watch	Run and watch mocha unit tests
lint	Run eslint static tests
compile	Compile the library
compile:watch	Compile and watch the library

Authors

Olivier Louvignes

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

Copyright and license

Apache License 2.0

Copyright (C) 2012-2014  Olivier Louvignes

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

Except where noted, this license applies to any and all software programs and associated documentation files created by the Original Author and distributed with the Software:

Inspired by SheetJS gist examples, Copyright (c) SheetJS.