csv-writer

Use createObjectCsvWriter to convert an array of objects into a CSV file. You can define a header with both an id (the key in your object) and a title (the column name in the CSV). If you provide only strings in the header array, no header line will be written to the file.

To write multiple batches of records to the same file, you must await the promise returned by writeRecords before calling it again to ensure data integrity.

const createCsvWriter = require('csv-writer').createObjectCsvWriter;
const csvWriter = createObjectCsvWriter({
    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)
    .then(() => {
        console.log('...Done');
    });

If you need a CSV string instead of writing directly to a file, use createObjectCsvStringifier or createArrayCsvStringifier. These return a stringifier object that provides methods to generate the header string and the record strings separately.

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'

Use createArrayCsvWriter when your data is structured as an array of arrays rather than an array of objects. The header option accepts an array of strings representing the column titles.

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)
    .then(() => {
        console.log('...Done');
    });

When using object-based CSV writers or stringifiers, headers can be defined using ObjectHeaderItem[] or string[].

• ObjectHeaderItem[]: An array of objects where each object specifies an id (the key in the source object) and a title (the column name in the CSV).
• string[]: An array of strings representing the column names.

Configuration options for createArrayCsvWriter(params):

Configuration options for createObjectCsvWriter(params):

Configuration options for createObjectCsvStringifier(params):