Package Exports
- convert-array-to-csv
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (convert-array-to-csv) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
convert-array-to-csv
Convert an array to a csv formatted string
Table of Contents
Why?
I needed a simple way to download the data from a table component in a csv format.
Installation
$ npm i convert-array-to-csv -Sor
$ yarn add convert-array-to-csvFunctions
Take a look into the usage section for a detailed example.
convertArrayToCSV
Note: you can also use the default export.
This function converts an array of objects, or an array of arrays into an csv formatted string.
Syntax
Returns a new string.
const csv = convertArrayToCSV(data, options);Parameters
- data: an array of arrays or an array of objects
- options: a object
- holds two keys: header and separator
- header: and array with the name of the columns, default:
undefined - separator: the character which is the separator in your csv formatted string, default:
','
Usage
An example how to use it.
const { convertArrayToCSV } = require('convert-array-to-csv');
const converter = require('convert-array-to-csv');
const header = ['number', 'first', 'last', 'handle'];
const dataArrays = [
[1, 'Mark', 'Otto', '@mdo'],
[2, 'Jacob', 'Thornton', '@fat'],
[3, 'Larry', 'the Bird', '@twitter'],
];
const dataObjects = [
{
number: 1,
first: 'Mark',
last: 'Otto',
handle: '@mdo',
},
{
number: 2,
first: 'Jacob',
last: 'Thornton',
handle: '@fat',
},
{
number: 3,
first: 'Larry',
last: 'the Bird',
handle: '@twitter',
},
];
/*
const csvFromArrayOfObjects = 'number,first,last,handle\n1,Mark,Otto,@mdo\n2,Jacob,Thornton,@fat\n3,Larry,the Bird,@twitter\n';
*/
const csvFromArrayOfObjects = convertArrayToCSV(dataObjects);
/*
const csvFromArrayOfArrays = 'number;first;last;handle\n1;Mark;Otto;@mdo\n2;Jacob;Thornton;@fat\n3;Larry;the Bird;@twitter\n';
*/
const csvFromArrayOfArrays = convertArrayToCSV(dataArrays, {
header,
separator: ';'
});License
MIT © Lukas Aichbauer