Security News
ESLint is Now Language-Agnostic: Linting JSON, Markdown, and Beyond
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
json-2-csv
Advanced tools
A JSON to CSV and CSV to JSON converter that natively supports sub-documents and auto-generates the CSV heading.
The json-2-csv npm package is a utility for converting JSON data to CSV format and vice versa. It is useful for data transformation tasks, especially when dealing with data interchange between systems that use different formats.
Convert JSON to CSV
This feature allows you to convert an array of JSON objects into a CSV string. The code sample demonstrates how to use the json2csv function to transform JSON data into CSV format.
const json2csv = require('json-2-csv');
const json = [
{ name: 'John', age: 30, city: 'New York' },
{ name: 'Anna', age: 22, city: 'London' },
{ name: 'Mike', age: 32, city: 'Chicago' }
];
json2csv.json2csv(json, (err, csv) => {
if (err) {
throw err;
}
console.log(csv);
});
Convert CSV to JSON
This feature allows you to convert a CSV string into an array of JSON objects. The code sample demonstrates how to use the csv2json function to transform CSV data into JSON format.
const json2csv = require('json-2-csv');
const csv = 'name,age,city\nJohn,30,New York\nAnna,22,London\nMike,32,Chicago';
json2csv.csv2json(csv, (err, json) => {
if (err) {
throw err;
}
console.log(json);
});
Custom Delimiters
This feature allows you to specify custom delimiters for fields and arrays when converting JSON to CSV. The code sample demonstrates how to use the json2csv function with custom delimiter options.
const json2csv = require('json-2-csv');
const json = [
{ name: 'John', age: 30, city: 'New York' },
{ name: 'Anna', age: 22, city: 'London' },
{ name: 'Mike', age: 32, city: 'Chicago' }
];
const options = {
delimiter: {
field: ';',
array: '|'
}
};
json2csv.json2csv(json, (err, csv) => {
if (err) {
throw err;
}
console.log(csv);
}, options);
The csv-parser package is a streaming CSV parser that converts CSV data into JSON objects. It is highly efficient for processing large CSV files. Unlike json-2-csv, which provides both JSON to CSV and CSV to JSON conversion, csv-parser focuses solely on parsing CSV to JSON.
The papaparse package is a powerful CSV parser that can handle large files and supports web workers for asynchronous parsing. It offers both CSV to JSON and JSON to CSV conversion, similar to json-2-csv, but with additional features like streaming and chunking for large datasets.
The fast-csv package is a comprehensive library for parsing and formatting CSV data. It supports both reading from and writing to CSV files, similar to json-2-csv. However, fast-csv is designed for high performance and can handle large datasets efficiently.
Convert JSON to CSV or CSV to JSON
This node module will convert an array of JSON documents to a CSV string. Column headings will be automatically generated based on the keys of the JSON documents. Nested documents will have a '.' appended between the keys.
It is also capable of converting CSV of the same form back into the original array of JSON documents. The columns headings will be used as the JSON document keys. All lines must have the same exact number of CSV values.
$ npm install json-2-csv
CLI:
$ npm install @mrodrig/json-2-csv-cli
Upgrading to v3 from v2? Check out the upgrade guide.
let converter = require('json-2-csv');
or
import { json2csv } from 'json-2-csv';
Looking for examples? Check out the Wiki: json-2-csv Wiki
converter.json2csv(array, callback, options)
array
- An array of JSON documents to be converted to CSV.callback
- A function of the form function (err, csv)
;
options
- (Optional) A JSON document specifying any of the following key value pairs:
checkSchemaDifferences
- Boolean - Should all documents have the same schema?
false
true
.delimiter
- Document - Specifies the different types of delimiters
field
- String - Field Delimiter.
,
wrap
- String - Wrap values in the delimiter of choice (e.g. wrap values in quotes).
"
eol
- String - End of Line Delimiter.
\n
emptyFieldValue
- Any - Value that, if specified, will be substituted in for field values that are undefined
, null
, or an empty string.
excelBOM
- Boolean - Should a unicode character be prepended to allow Excel to open a UTF-8 encoded file with non-ASCII characters present.expandArrayObjects
- Boolean - Should objects in array values be deep-converted to CSV?
false
[
{
"specifications": [
{ "features": [...] },
{ "mileage": "5000" }
]
}
]
true
uses the following keys:
['specifications.features', 'specifications.mileage']
false
uses the following keys:
['specifications']
keys
- Array - Specify the keys (as strings) that should be converted.
null
null
or don't specify the option to utilize the default.prependHeader
- Boolean - Should the auto-generated header be prepended as the first line in the CSV?
true
sortHeader
- Boolean - Should the header keys be sorted in alphabetical order?
false
trimHeaderFields
- Boolean - Should the header fields be trimmed?
false
trimFieldValues
- Boolean - Should the field values be trimmed? (in development)
false
For examples, please refer to the json2csv API Documentation (Link)
converter.json2csvAsync(array, options)
Available in version 2.2.0
, this functionality makes use of promises from the bluebird
module.
converter.csv2json(csv, callback, options)
csv
- A string of CSVcallback
- A function of the form function (err, array)
; This function will receive any errors and/or the array of JSON documents generated.options
- (Optional) A JSON document specifying any of the following key value pairs:
delimiter
- Document - Specifies the different types of delimiters
field
- String - Field Delimiter.
,
wrap
- String - The character that field values are wrapped in.
"
eol
- String - End of Line Delimiter.
\n
excelBOM
- Boolean - Does the CSV contain a unicode character prepended in order to allow Excel to open a UTF-8 encoded file with non-ASCII characters present?
false
keys
- Array - Specify the keys (as strings) that should be converted.
null
{info : {name: 'Mike'}}
), then set this to ['info.name']
null
or don't specify the option to utilize the default.trimHeaderFields
- Boolean - Should the header fields be trimmed?
false
trimFieldValues
- Boolean - Should the field values be trimmed?
false
For examples, please refer to the csv2json API Documentation (Link)
csv2jsonAsync(csv, options)
Available in version 2.2.0
, this functionality makes use of promises from the bluebird
module.
Note: As of 3.5.8
, the command line interface functionality has been pulled out to a separate package. Please be sure to
install the @mrodrig/json-2-csv-cli
NPM package if you wish to use the CLI functionality shown below:
$ npm install @mrodrig/json-2-csv-cli
Usage: json2csv <jsonFile> [options]
Options:
-V, --version output the version number
-o, --output [output] Path of output file. If not provided, then stdout will be used
-f, --field <delimiter> Optional field delimiter
-w, --wrap <delimiter> Optional wrap delimiter
-e, --eol <delimiter> Optional end of line delimiter
-b, --excel-bom Excel Byte Order Mark character prepended to CSV
-W, --without-header Withhold the prepended header
-s, --sort-header Sort the header fields
-H, --trim-header Trim header fields
-F, --trim-fields Trim field values
-S, --check-schema Check for schema differences
-E, --empty-field-value <value> Empty field value
-A, --expand-array-objects Expand array objects
-k, --keys [keys] Keys of documents to convert to CSV
-h, --help output usage information
Usage: csv2json <csvFile> [options]
Options:
-V, --version output the version number
-c, --csv <csv> Path of json file to be converted
-o, --output [output] Path of output file. If not provided, then stdout will be used
-f, --field <delimiter> Optional field delimiter
-w, --wrap <delimiter> Optional wrap delimiter
-e, --eol <delimiter> Optional end of line delimiter
-b, --excel-bom Excel Byte Order Mark character prepended to CSV
-H, --trim-header Trim header fields
-F, --trim-fields Trim field values
-k, --keys [keys] Keys of documents to convert to CSV
-h, --help output usage information
$ npm test
To see test coverage, please run:
$ npm run coverage
Current Coverage is:
Statements : 100% ( 286/286 )
Branches : 100% ( 166/166 )
Functions : 100% ( 73/73 )
Lines : 100% ( 280/280 )
Please find the updated list (relocated to the Wiki) here: Frequently Asked Questions (Link)
csv2json test.csv -o output.json
json2csv test.json -o output.csv -W -k arrayOfStrings -o output.csv
FAQs
A JSON to CSV and CSV to JSON converter that natively supports sub-documents and auto-generates the CSV heading.
The npm package json-2-csv receives a total of 367,494 weekly downloads. As such, json-2-csv popularity was classified as popular.
We found that json-2-csv demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
ESLint has added JSON and Markdown linting support with new officially-supported plugins, expanding its versatility beyond JavaScript.
Security News
Members Hub is conducting large-scale campaigns to artificially boost Discord server metrics, undermining community trust and platform integrity.
Security News
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.