![Build Status](https://api.travis-ci.org/adaltas/node-csv-stringify.svg)
Part of the CSV module, this project is a stringifier converting
arrays or objects input into a CSV text. It implements the Node.js
stream.Transform
API. It also provides a simple
callback-based API for convenience. It is both extremely easy to use and
powerful. It was first released in 2010 and is used against big data sets by a
large community.
Documentation for the "csv-stringify" package is available here.
Main features
- Follow the Node.js streaming API
- Simplicity with the optional callback API
- Support for custom formatters, delimiters, quotes, escape characters and header
- Support big datasets
- Complete test coverage and samples for inspiration
- Only 1 external dependency
- to be used conjointly with
csv-generate
, csv-parse
and stream-transform
- BSD License
Usage
Refer to the project webpage for an exhaustive list of options
and some usage examples.
The module is built on the Node.js Stream API. For the sake of simplicity, a
simple callback API is also provided. To give you a quick look, here's an
example of the callback API:
var stringify = require('csv-stringify');
input = [ [ '1', '2', '3', '4' ], [ 'a', 'b', 'c', 'd' ] ];
stringify(input, function(err, output){
output.should.eql('1,2,3,4\na,b,c,d\n');
});
Development
Tests are executed with mocha. To install it, run npm install
followed by npm test
. It will install mocha and its dependencies in your
project "node_modules" directory and run the test suite. The tests run
against the CoffeeScript source files.
To generate the JavaScript files, run npm run coffee
.
The test suite is run online with Travis. See the Travis definition file to view the tested Node.js version.
Contributors