Neatly Packaged Magic

    @algonomia/convert-array-to-csv

    1.0.0 • Public • Published

    convert-array-to-csv

    npm Travis branch Codecov branch

    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 -S

    or

    $ yarn add convert-array-to-csv

    Functions

    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

    Install

    npm i @algonomia/convert-array-to-csv

    DownloadsWeekly Downloads

    8

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    16.3 kB

    Total Files

    13

    Last publish

    Collaborators

    • brice.guillaume