Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

214 lines (163 sloc) 5.773 kB
language layout title date comments sharing footer navigation github
en
page
Node CSV
2012-11-16 16:02:50 UTC
false
false
false
csv

This project provides CSV parsing and has been tested and used on a large input file (over 2Gb).

  • Follow the Node.js streaming API
  • Async and event based
  • Support delimiters, quotes and escape characters
  • Line breaks discovery: detected in source and reported to destination
  • Data transformation
  • Support for large datasets
  • Complete test coverage as sample and inspiration
  • no external dependencies

Important, this documentation cover the current version of the node csv parser. The documentation for the current version 0.1.0 is available here.

Installation

npm install csv

Quick example

// node samples/string.js
var csv = require('csv');
csv()
.from( '"1","2","3","4"\n"a","b","c","d"' )
.to( console.log )
// Output:
// 1,2,3,4
// a,b,c,d

Advanced example

The following example illustrates 4 usages of the library: 1. Plug a readable stream by defining a file path 2. Direct output to a file path 3. Transform the data (optional) 4. Listen to events (optional)

// node samples/sample.js
var csv = require('csv');
csv()
.from.stream(fs.createReadStream(__dirname+'/sample.in')
.to.path(__dirname+'/sample.out')
.transform( function(data){
  data.unshift(data.pop());
  return data;
})
.on('record', function(data,index){
  console.log('#'+index+' '+JSON.stringify(data));
})
.on('end', function(count){
  console.log('Number of lines: '+count);
})
.on('error', function(error){
  console.log(error.message);
});
// Output:
// #0 ["2000-01-01","20322051544","1979.0","8.8017226E7","ABC","45"]
// #1 ["2050-11-27","28392898392","1974.0","8.8392926E7","DEF","23"]
// Number of lines: 2

Pipe example

The module follow a Stream architecture. At it's core, the parser and the stringifier utilities provide a Stream Writer and a Stream Reader implementation available in the CSV API.

|-----------|      |---------|---------|       |---------|
|           |      |         |         |       |         |
|           |      |        CSV        |       |         |
|           |      |         |         |       |         |
|  Stream   |      |  Writer |  Reader |       |  Stream |
|  Reader   |.pipe(|   API   |   API   |).pipe(|  Writer |)
|           |      |         |         |       |         |
|           |      |         |         |       |         |
|-----------|      |---------|---------|       |---------|

Here's a quick example:

in = fs.createReadStream('./in')
out = fs.createWriteStream('./out')
in.pipe(csv()).pipe(out)

Installing

Via npm:

npm install csv

Via git (or downloaded tarball):

git clone http://github.com/wdavidw/node-csv-parser.git

Events

The library extends Node EventEmitter class and emit all the events of the Writable and Readable Stream API. Additionally, the useful "records" event is emitted.

  • record
    Emitted by the stringifier when a new row is parsed and transformed. The data is the value returned by the user transform callback if any. Note however that the event won't be called if transform return null since the record is skipped. The callback provides two arguments. data is the CSV line being processed (an array or an object) and index is the index number of the line starting at zero
  • data
    Emitted by the stringifier on each line once the data has been transformed and stringified.
  • drain
  • end
    Emitted when the CSV content has been parsed.
  • close
    Emitted when the underlying resource has been closed. For example, when writting to a file with csv().to.path(), the event will be called once the writing process is complete and the file closed.
  • error
    Thrown whenever an error occured.

pause()

Implementation of the Readable Stream API, requesting that no further data be sent until resume() is called.

resume()

Implementation of the Readable Stream API, resuming the incoming 'data' events after a pause().

write(data, [preserve])

Implementation of the Writable Stream API with a larger signature. Data may be a string, a buffer, an array or an object.

If data is a string or a buffer, it could span multiple lines. If data is an object or an array, it must represent a single line. Preserve is for line which are not considered as CSV data.

end()

Terminate the parsing. Call this method when no more csv data is to be parsed. It implement the StreamWriter API by setting the writable property to "false" and emitting the end event.

transform(callback)

Register the transformer callback. The callback is a user provided function call on each line to filter, enrich or modify the dataset. More information in the "transforming data" section.

error(error)

Unified mechanism to handle error, emit the error and mark the stream as non readable and non writable.

Jump to Line
Something went wrong with that request. Please try again.