Skip to content

baranovxyz/xlsx-stream-writer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Right now this package is used as a quick way to generate very large excel xlsx files with simple formatting. No date conversions etc.

Creating an xlsx blob in browser for 150000 rows x 80 columns of different data takes around 60 seconds.

This was rewritten from coffee script https://github.com/rubenv/node-xlsx-writer and changed to work both in browser and nodejs. Api is completely different from rubenv implementation.

It is actually capable of streaming rows into xlsx file both in browser and nodejs.

It uses JSZip to compress resulting structure. Lucky for us JSZip is capable of processing readable streams, so we just stream rows into xlxs file (which is a zip file).

Plans:

  • improve api
  • add tests
  • make browser build, put on some cdn
  • optimize shared string stuff
  • maybe use web workers to build xlsx in browser
  • maybe implement some specifis for nodejs

You can add rows:

const XlsxStreamWriter = require("xlsx-stream-writer");
const fs = require("fs");

const rows = [
  ["Name", "Location"],
  ["Alpha", "Adams"],
  ["Bravo", "Boston"],
  ["Charlie", "Chicago"]
];

const xlsx = new XlsxStreamWriter();
xlsx.addRows(rows);

xlsx.getFile().then(buffer => {
  fs.writeFileSync("result.xlsx", buffer);
});

Or add readable stream of rows:

const XlsxStreamWriter = require("xlsx-stream-writer");
const Readable = require("stream-browserify").Readable;
const fs = require("fs");

const rows = [
  ["Name", "Location"],
  ["Alpha", "Adams"],
  ["Bravo", "Boston"],
  ["Charlie", "Chicago"]
];

function wrapRowsInStream(rows) {
  const rs = Readable({ objectMode: true });
  let c = 0;
  rs._read = function() {
    if (c === rows.length) rs.push(null);
    else rs.push(rows[c]);
    c++;
  };
  return rs;
}
const streamOfRows = wrapRowsInStream(rows);

const xlsx = new XlsxStreamWriter();
xlsx.addRows(streamOfRows);

xlsx.getFile().then(buffer => {
  fs.writeFileSync("result.xlsx", buffer);
});

About

Create xlsx in streaming mode in browser and nodejs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published