# neat-csv

> Fast CSV parser

Latest version **7.0.0** (published 2021-10-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install neat-csv
pnpm add neat-csv
yarn add neat-csv
bun add neat-csv
```

## Health

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

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 7.0.0 |
| Published | 2021-10-18 |
| First published | 2015-05-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/neat-csv) |
| Module format | ESM |
| Node | ^12.20.0 \|\| ^14.13.1 \|\| >=16.0.0 |
| Dependencies | 2 |
| Unpacked size | 4.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 326 |
| Author | Sindre Sorhus |
| Maintainers | sindresorhus |
| Keywords | parse, csv, comma, separated, values, tab, delimiter, separator, text, string, buffer, stream, parser |

## Links

- npm: https://www.npmjs.com/package/neat-csv
- Repository: https://github.com/sindresorhus/neat-csv
- Homepage: https://github.com/sindresorhus/neat-csv#readme
- Issues: https://github.com/sindresorhus/neat-csv/issues
- Funding: https://github.com/sponsors/sindresorhus
- npm.io page: https://npm.io/package/neat-csv

## Dependencies (2)

- [csv-parser](https://npm.io/package/csv-parser.md) ^3.0.0
- [get-stream](https://npm.io/package/get-stream.md) ^6.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

- 7.0.0 (latest) — 2021-10-18
- 6.0.1 — 2021-01-14
- 6.0.0 — 2020-12-07
- 5.2.0 — 2020-02-12
- 5.1.0 — 2019-07-07
- 5.0.0 — 2019-04-20
- 4.0.0 — 2018-11-02
- 3.0.0 — 2018-08-10
- 2.1.0 — 2016-04-28
- 2.0.0 — 2016-04-20
- 1.1.0 — 2015-08-20
- 1.0.0 — 2015-05-29

## README

# neat-csv

> Fast CSV parser

Convenience wrapper around the super-fast streaming [`csv-parser`](https://github.com/mafintosh/csv-parser) module. Use that one if you want streamed parsing.

Parsing-related issues should be reported to [`csv-parser`](https://github.com/mafintosh/csv-parser/issues).

## Install

```sh
npm install neat-csv
```

## Usage

```js
import neatCsv from 'neat-csv';

const csv = 'type,part\nunicorn,horn\nrainbow,pink';

console.log(await neatCsv(csv));
//=> [{type: 'unicorn', part: 'horn'}, {type: 'rainbow', part: 'pink'}]
```

## API

### neatCsv(data, options?)

Returns a `Promise<object[]>` with the parsed CSV.

#### data

Type: `string | Buffer | stream.Readable`

The CSV data to parse.

#### options

Type: `object`

See the [`csv-parser` options](https://github.com/mafintosh/csv-parser#options).

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