https://github.com/max-mapper/csv-write-stream

A CSV encoder stream that produces properly escaped CSVs
https://github.com/max-mapper/csv-write-stream

Last synced: 28 days ago
JSON representation

A CSV encoder stream that produces properly escaped CSVs

• Host: GitHub
• URL: https://github.com/max-mapper/csv-write-stream
• Owner: max-mapper
• License: bsd-2-clause
• Created: 2014-01-23T23:40:52.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-09-02T09:01:29.000Z (about 4 years ago)
• Last Synced: 2024-05-13T16:24:56.023Z (6 months ago)
• Language: JavaScript
• Homepage:
• Size: 32.2 KB
• Stars: 205
• Watchers: 9
• Forks: 37
• Open Issues: 17
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# csv-write-stream

A CSV encoder stream that produces properly escaped CSVs.

[![NPM](https://nodei.co/npm/csv-write-stream.png)](https://nodei.co/npm/csv-write-stream/)

[![browser support](http://ci.testling.com/maxogden/csv-write-stream.png)](http://ci.testling.com/maxogden/csv-write-stream)

A through stream. Write arrays of strings (or JS objects) and you will receive a properly escaped CSV stream out the other end.

## usage

### var writer = csvWriter([options])

```javascript

var csvWriter = require('csv-write-stream')

var writer = csvWriter()

```

`writer` is a duplex stream -- you can pipe data to it and it will emit a string for each line of the CSV

### default options

```javascript

{

  separator: ',',

  newline: '\n',

  headers: undefined,

  sendHeaders: true

}

```

`headers` can be an array of strings to use as the header row. if you don't specify a header row the keys of the first row written to the stream will be used as the header row IF the first row is an object (see the test suite for more details). if the `sendHeaders` option is set to false, the headers will be used for ordering the data but will never be written to the stream.

example of auto headers:

```javascript

var writer = csvWriter()

writer.pipe(fs.createWriteStream('out.csv'))

writer.write({hello: "world", foo: "bar", baz: "taco"})

writer.end()

// produces: hello,foo,baz\nworld,bar,taco\n

```

example of specifying headers:

```javascript

var writer = csvWriter({ headers: ["hello", "foo"]})

writer.pipe(fs.createWriteStream('out.csv'))

writer.write(['world', 'bar'])

writer.end()

// produces: hello,foo\nworld,bar\n

```

example of not sending headers:

```javascript

var writer = csvWriter({sendHeaders: false})

writer.pipe(fs.createWriteStream('out.csv'))

writer.write({hello: "world", foo: "bar", baz: "taco"})

writer.end()

// produces: world,bar,taco\n

```

see the test suite for more examples

## run the test suite

```bash

$ npm install

$ npm test

```

## cli usage

This module also includes a CLI, which you can pipe [ndjson](http://ndjson.org) to stdin and it will print csv on stdout. You can install it with `npm install -g csv-write-stream`.

```bash

$ csv-write --help

usage: csv-write [-h] [-v] [--separator SEPARATOR] [--newline NEWLINE]

                 [--headers HEADERS [HEADERS ...]] [--no-send-headers]

A CSV encoder stream that produces properly escaped CSVs. JSON is read from

STDIN, formatted to CSV, and written to STDOUT.

Optional arguments:

  -h, --help            Show this help message and exit.

  -v, --version         Show program's version number and exit.

  --separator SEPARATOR

                        The separator character to use. Defaults to ','.

  --newline NEWLINE     The newline character to use. Defaults to $'\n'.

  --headers HEADERS [HEADERS ...]

                        The list of headers to use. If omitted, the keys of

                        the first row written to STDIN will be used

  --no-send-headers     Don't print the header row.

```

```bash

$ cat example.ndjson | csv-write > example.csv

```