CSV Writer (Browser)

This project was original forked from Ryuichi Inagaki's csv-writer but it did not support running in a browser due to the lack of support for fs/path/etc. It should not be used unless you are specifically running into the issue of not being able to compile/transpile your code due to the lack of fs support. There is a pull request to add this functionality to the original project, and this package and all associated files will be deleted as soon as that pull request is added.

Convert objects/arrays into a CSV string or write them into a file.
It respects RFC 4180 for the output CSV format.

Prerequisite

* Node version 4 or above

Usage

The example below shows how you can write records defined as the array of objects into a file.

``js
const createCsvWriter = require('csv-writer').createObjectCsvWriter;
const csvWriter = createCsvWriter({
path: 'path/to/file.csv',
header: [
{id: 'name', title: 'NAME'},
{id: 'lang', title: 'LANGUAGE'}
]
});

const records = [
{name: 'Bob', lang: 'French, English'},
{name: 'Mary', lang: 'English'}
];

csvWriter.writeRecords(records) // returns a promise
.then(() => {
console.log('...Done');
});

// This will produce a file path/to/file.csv with following contents:
//
// NAME,LANGUAGE
// Bob,"French, English"
// Mary,English
`

You can keep writing records into the same file by calling writeRecords multiple times
(but need to wait for the fulfillment of the promise of the previous writeRecords call).

`js
// In an async function
await csvWriter.writeRecords(records1)
await csvWriter.writeRecords(records2)
...
`

However, if you need to keep writing large data to a certain file, you would want to create
node's transform stream and use CsvStringifier, which is explained later, inside it
, and pipe the stream into a file write stream.

If you don't want to write a header line, don't give title to header elements and just give field IDs as a string.

`js
const createCsvWriter = require('csv-writer').createObjectCsvWriter;
const csvWriter = createCsvWriter({
path: 'path/to/file.csv',
header: ['name', 'lang']
});
`

If each record is defined as an array, use createArrayCsvWriter to get an csvWriter.

`js
const createCsvWriter = require('csv-writer').createArrayCsvWriter;
const csvWriter = createCsvWriter({
header: ['NAME', 'LANGUAGE'],
path: 'path/to/file.csv'
});

const records = [
['Bob', 'French, English'],
['Mary', 'English']
];

csvWriter.writeRecords(records) // returns a promise
.then(() => {
console.log('...Done');
});

// This will produce a file path/to/file.csv with following contents:
//
// NAME,LANGUAGE
// Bob,"French, English"
// Mary,English
`

If you just want to get a CSV string but don't want to write into a file,
you can use createObjectCsvStringifier (or createArrayCsvStringifier)
to get an csvStringifier.

`js
const createCsvStringifier = require('csv-writer').createObjectCsvStringifier;
const csvStringifier = createCsvStringifier({
header: [
{id: 'name', title: 'NAME'},
{id: 'lang', title: 'LANGUAGE'}
]
});

const records = [
{name: 'Bob', lang: 'French, English'},
{name: 'Mary', lang: 'English'}
];

console.log(csvStringifier.getHeaderString());
// => 'NAME,LANGUAGE\n'

console.log(csvStringifier.stringifyRecords(records));
// => 'Bob,"French, English"\nMary,English\n'
`

API

$3

##### Parameters:

* params