You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
43 lines
876 B
Markdown
43 lines
876 B
Markdown
4 years ago
|
# neat-csv [](https://travis-ci.org/sindresorhus/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.
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```
|
||
|
|
$ npm install neat-csv
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
const neatCsv = require('neat-csv');
|
||
|
|
|
||
|
|
const csv = 'type,part\nunicorn,horn\nrainbow,pink';
|
||
|
|
|
||
|
|
(async () => {
|
||
|
|
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`
|
||
|
|
|
||
|
|
CSV data to parse.
|
||
|
|
|
||
|
|
#### options
|
||
|
|
|
||
|
|
Type: `object`
|
||
|
|
|
||
|
|
See the [`csv-parser` options](https://github.com/mafintosh/csv-parser#options).
|