{"id":17398468,"url":"https://github.com/vweevers/spreadsheet-stream","last_synced_at":"2025-04-30T05:22:41.633Z","repository":{"id":34923054,"uuid":"190697060","full_name":"vweevers/spreadsheet-stream","owner":"vweevers","description":"Semi-streaming XLS(X) / ODS / QPW (and more) parser.","archived":false,"fork":false,"pushed_at":"2023-02-01T10:02:38.000Z","size":11,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-25T01:58:22.152Z","etag":null,"topics":["duplex-stream","nodejs","ods","qpw","spreadsheets","stream","xls","xlsx"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vweevers.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-06-07T06:18:07.000Z","updated_at":"2023-05-26T21:50:23.000Z","dependencies_parsed_at":"2023-02-17T04:10:21.577Z","dependency_job_id":null,"html_url":"https://github.com/vweevers/spreadsheet-stream","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vweevers%2Fspreadsheet-stream","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vweevers%2Fspreadsheet-stream/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vweevers%2Fspreadsheet-stream/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vweevers%2Fspreadsheet-stream/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vweevers","download_url":"https://codeload.github.com/vweevers/spreadsheet-stream/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251645989,"owners_count":21620848,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["duplex-stream","nodejs","ods","qpw","spreadsheets","stream","xls","xlsx"],"created_at":"2024-10-16T14:57:01.296Z","updated_at":"2025-04-30T05:22:41.616Z","avatar_url":"https://github.com/vweevers.png","language":"JavaScript","readme":"# spreadsheet-stream\n\n\u003e **Semi-streaming XLS(X) / ODS / QPW ([and more](https://github.com/SheetJS/js-xlsx)) parser.**  \n\u003e \"Semi\" because these spreadsheet formats are not streamable so the whole thing is buffered in memory. Same as [`excel-stream`](https://github.com/dominictarr/excel-stream) but faster because there's no filesystem IO or child process.\n\n[![npm status](http://img.shields.io/npm/v/spreadsheet-stream.svg)](https://www.npmjs.org/package/spreadsheet-stream)\n[![node](https://img.shields.io/node/v/spreadsheet-stream.svg)](https://www.npmjs.org/package/spreadsheet-stream)\n[![Test](https://img.shields.io/github/workflow/status/vweevers/spreadsheet-stream/Test?label=test)](https://github.com/vweevers/spreadsheet-stream/actions/workflows/test.yml)\n[![Standard](https://img.shields.io/badge/standard-informational?logo=javascript\u0026logoColor=fff)](https://standardjs.com)\n\n## Example\n\n```\nnpm i spreadsheet-stream format-data\n```\n\n```js\nconst sheet = require('spreadsheet-stream')\nconst format = require('format-data')\nconst fs = require('fs')\n\nfs.createReadStream('example.xlsx')\n  .pipe(sheet())\n  .pipe(format('json'))\n  .pipe(process.stdout)\n```\n\nNB. Although the underlying parser ([`xlsx`](https://github.com/SheetJS/js-xlsx)) also supports non-binary formats like CSV, for those formats you're better off with truly streaming solutions like [`tabular-stream`](https://github.com/vweevers/tabular-stream) (to support both spreadsheets and CSV), [`csv-parser`](https://github.com/mafintosh/csv-parser) or similar. Those are not limited by memory. For a command-line interface, see [`tabular-cli`](https://www.npmjs.com/package/tabular-cli).\n\n## API\n\n### `sheet([options])`\n\nReturns a duplex stream of which the writable side takes a spreadsheet and the readable side yields row objects. Options:\n\n- `maxSize` (number, default 0): destroy stream when more than `maxSize` bytes have been written (i.e. reject big files)\n- `sheetIndex` (number, default 0): select a sheet\n- `sheet` (string, default none): select a sheet by its name. Takes precedence over `sheetIndex`.\n\n## Install\n\nWith [npm](https://npmjs.org) do:\n\n```\nnpm install spreadsheet-stream\n```\n\n## License\n\n[MIT](LICENSE.md) © 2019-present Vincent Weevers.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvweevers%2Fspreadsheet-stream","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvweevers%2Fspreadsheet-stream","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvweevers%2Fspreadsheet-stream/lists"}