Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sydev/p-csv-parser

A simple and blazing fast csv parser, promisified.
https://github.com/sydev/p-csv-parser

Last synced: 12 days ago
JSON representation

A simple and blazing fast csv parser, promisified.

Awesome Lists containing this project

README

        

# p-csv-parser

[![Build Status](https://travis-ci.org/sydev/p-csv-parser.svg?branch=master)](https://travis-ci.org/sydev/p-csv-parser)

A simple and blazing fast csv parser, promisified.

## Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [API](#api)
- [Development](#development)
- [Changelog](#changelog)

## Installation

```
$ npm install --save p-csv-parser
```

Or if you prefer yarn:

```
$ yarn add p-csv-parser
```

## Usage

```JavaScript
const csvParser = require('p-csv-parser');

csvParser(csvString)
.then(results => console.log(results)); // Array of rows as objects

```

## API

### csvParser(csvString, options)

- ```csvString``` String (required) - The csv content to parse
- ```options``` Object (optional)
- ```headers``` Boolean|Array - If true, the first line of ```csvString``` is parsed as headers, else use the array. Default: ```true```
- ```delimiter``` String - Set the field delimiter, Default: ```","```

## Development

```
$ npm test
```

## Changelog

- 1.0.2
- Fix error with large files. Tested with file containing roundabout 155000 lines
- 1.0.1
- Fix module error
- 1.0.0
- Initial Release