xls-stream v1.2.4

This project is a fork from https://github.com/dominictarr/excel-stream and i've just updated the csv-stream library to be compatible with newer node versions

xls-stream

A stream that converts excel spreadsheets into JSON object arrays.

Examples

// stream rows from the first sheet on the file
var excel = require('xls-stream')
var fs = require('fs')

fs.createReadStream('accounts.xlsx')
  .pipe(excel())  // same as excel({sheetIndex: 0})
  .on('data', console.log)

// stream rows from the sheet named 'Your sheet name'
var excel = require('xls-stream')
var fs = require('fs')

fs.createReadStream('accounts.xlsx')
  .pipe(excel({
     sheet: 'Your sheet name'
  }))
  .on('data', console.log)

stream options

The options object may have the same properties as csv-stream and these three additional properties:

• sheet: the name of the sheet you want to stream. Case sensitive.
• sheetIndex: the sheet number you want to stream (0-based).
• allSheets: boolean indicating if all sheets should be used instead of just the one provided with the sheetIndex or sheet argument. If allSheets is true then sheetIndex and sheet arguments will be ignored

Usage

npm install -g xls-stream
xls-stream < accounts.xlsx > account.json

options

newline delimited json:

xls-stream --newlines

formats

each row becomes a javascript object, so input like

foo, bar, baz
  1,   2,   3
  4,   5,   6

will become

[{
  foo: 1,
  bar: 2,
  baz: 3
}, {
  foo: 4,
  bar: 5,
  baz: 6
}]

Don't Look Now

So, excel isn't really a streamable format. But it's easy to work with streams because everything is a stream. This writes to a tmp file, then pipes it through xlsx then into csv-stream

License

MIT