# spreadsheet-parser

> Parse spreadsheet files with ease.

Latest version **2.0.0** (published 2024-08-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install spreadsheet-parser
pnpm add spreadsheet-parser
yarn add spreadsheet-parser
bun add spreadsheet-parser
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2024-08-26 |
| First published | 2021-12-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Bloggify |
| Maintainers | ionicabizau |
| Keywords | spreadsheet, parser, parse, files, with, ease |

## Links

- npm: https://www.npmjs.com/package/spreadsheet-parser
- Repository: https://github.com/Bloggify/spreadsheet-parser
- Homepage: https://github.com/Bloggify/spreadsheet-parser#readme
- Issues: https://github.com/Bloggify/spreadsheet-parser/issues
- npm.io page: https://npm.io/package/spreadsheet-parser

## Dependencies (3)

- [xlsx](https://npm.io/package/xlsx.md) ^0.17.4
- [csv-it](https://npm.io/package/csv-it.md) ^1.2.1
- [excel-column-name](https://npm.io/package/excel-column-name.md) ^1.0.1

## Alternatives

- [csv-to-markdown-table](https://npm.io/package/csv-to-markdown-table.md) — 47.0K weekly downloads
- [@sapphire/ratelimits](https://npm.io/package/@sapphire/ratelimits.md) — 4.4K weekly downloads
- [js-csvparser](https://npm.io/package/js-csvparser.md) — 2.0K weekly downloads
- [@adadapted/js-sdk](https://npm.io/package/@adadapted/js-sdk.md) — 251 weekly downloads
- [@grapecity/spread-sheets-sparklines](https://npm.io/package/@grapecity/spread-sheets-sparklines.md) — 103 weekly downloads

## Recent versions

- 2.0.0 (latest) — 2024-08-26
- 1.0.0 — 2021-12-08

## README

<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


















# spreadsheet-parser

 [![Version](https://img.shields.io/npm/v/spreadsheet-parser.svg)](https://www.npmjs.com/package/spreadsheet-parser) [![Downloads](https://img.shields.io/npm/dt/spreadsheet-parser.svg)](https://www.npmjs.com/package/spreadsheet-parser)







> Parse spreadsheet files with ease.

















## :cloud: Installation

```sh
# Using npm
npm install --save spreadsheet-parser

# Using yarn
yarn add spreadsheet-parser
```













## :clipboard: Example



```js
const SpreadsheetParser = require("spreadsheet-parser");


(async () => {
    const content = await SpreadsheetParser(`${__dirname}/sample.xlsx`)
    console.log(content)

    const csvContent = await SpreadsheetParser(`${__dirname}/sample.csv`, {
        headers: true
    })
    console.log(csvContent)
})()
```












## :question: Get Help

There are few ways to get help:



 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
 2. For bug reports and feature requests, open issues. :bug:







## :memo: Documentation


### `spreadsheetParser(filePath, opts)`
Parse spreadsheet files with ease.

#### Params

- **Strings** `filePath`: The spreadsheet file path.
- **Object** `opts`: The options to pass to the processor.

#### Return
- **Promise\<Array>** A promise resolving the array content of the spreadsheet.














## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].
























## :scroll: License

[MIT][license] © [Bloggify][website]






[license]: /LICENSE
[website]: https://bloggify.org
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md

---
_Source: https://npm.io/package/spreadsheet-parser · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._