Easily encode complex JSON objects to CSV with CsvBuilder's schema-like API
Alternatives To Csvbuilder
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Papaparse11,6111,9821,2914 days ago41March 23, 2023176mitJavaScript
Fast and powerful CSV (delimited text) parser that gracefully handles large files and malformed input
Fast Csv1,4361,948617a day ago71December 04, 202066mitTypeScript
CSV parser and formatter for node
a year ago117mitC#
The FileHelpers are a free and easy to use .NET library to read/write data from fixed length or delimited records in files, strings or streams
Csv462200433 days ago37September 17, 20222mitElixir
CSV Decoding and Encoding for Elixir
React Papaparse311273 months ago50August 13, 202249mitTypeScript
react-papaparse is the fastest in-browser CSV (or delimited text) parser for React. It is full of useful features such as CSVReader, CSVDownloader, readString, jsonToCSV, readRemoteFile, ... etc.
Tabulator Py20852212 years ago141March 21, 20211mitPython
Python library for reading and writing tabular data via streams.
Csv Write Stream1884421393 years ago12April 28, 201612bsd-2-clauseJavaScript
A CSV encoder stream that produces properly escaped CSVs
Csvbuilder1291255 years ago6August 23, 20182mitJavaScript
Easily encode complex JSON objects to CSV with CsvBuilder's schema-like API
Excel Stream12917105 years ago12July 21, 201510mitJavaScript
Csv12822a month ago2July 07, 20222mitC#
Fast C# CSV parser
Alternatives To Csvbuilder
Select To Compare

Alternative Project Comparisons



Easily encode complex JSON objects to CSV with CsvBuilder's schema-like API.

Table Of Contents


const CsvBuilder = require('csv-builder')

const data = [
    name: 'Foo Bar',
    meta: {
      active: true,
      roles: [

const builder = new CsvBuilder({
  headers: ['Firstname', 'Lastname', 'Role 1', 'Role 2', 'Active'],
  alias: {
    'Role 1': 'meta.roles[0]',
    'Role 2': 'meta.roles[1]',
    'Active': 'meta.active'
  .virtual('Firstname', user => user.name.split(' ')[0])
  .virtual('Lastname', user => user.name.split(' ')[1])

/* Each of the following produces the following CSV contents:

"Firstname","Lastname","Role 1","Role 2","Active"


// (1) Create from a Stream of objects (like a database)

// (2) Create from an existing payload (`data` is an array of objects)

// (3) Roll your own
let csv = ''
csv += builder.getHeaders()
data.forEach(item => {
  csv += builder.getRow(item)
fs.writeFileSync('output.csv', csv)


$ npm i -s csv-builder
# or
$ yarn add csv-builder

New Features

  • More cohesive API
  • Expanded API to support non-stream outputs, i.e. building a CSV string row-by-row with the getHeaders() and getRow(object) methods respectively.
  • Better CSV encoding (proper quoting by default)


  • headers String|Array Space separated headers, or array of headers (required)
  • delimiter String The column delimiter. Default ','
  • terminator String The row terminator. Default '\n'
  • quoted Boolean Quote columns? Default true
  • alias Object An object in the format of { "csv header": "object prop" }, object prop will be aliased to csv header. Default {}


CsvBuilder#createReadStream(payload): Stream.Readable

Creates a readable stream and consumes the payload.

  • payload Array<Object> Incoming data.
CsvBuilder#createTransformStream(): Stream.Transform

Creates a transform stream. The stream expects either Objects or JSON.

CsvBuilder#headers(headers): this
  • headers String|Array Space separated headers, or array of headers
CsvBuilder#alias(header, prop): this

Set single or multiple contraints. If header is an object, it will extend any existing constraints, not replace.

  • header String|Object Either object {"header": "property"} Or a string "Header"
  • prop String|undefined Property to correspond to header, omit if using object.
CsvBuilder#virtual(prop, fn): this

Create a virtual property. Virtual properties are treated the same as normal properties. If there is no corresponding header or alias, the virtual will not be present in resulting CSV.

  • prop String Virtual property name
  • fn (item: any) => any Where item is an element from the incoming data, and the return value is the corresponding value for the virtualized property.
CsvBuilder#getHeaders(): String

The headers in CSV format

CsvBuilder#getRow(item): String

Returns the CSV formated row for a given item.

  • item Object A n item matching the "schema".

Migration to 1.0.0

  • constraints attribute in options (for constructor) is deprecated, use alias instead.
  • set(prop, value) method is deprecated, use alias(prop, value) instead.
Popular Csv Projects
Popular Stream Projects
Popular Data Formats Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.