JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 341470
  • Score
    100M100P100Q168815F
  • License MIT

Easily create CSV data from json collection

Package Exports

  • export-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 (export-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

export-to-csv | Export to CSV Mini Library

Based off of this library by Javier Telio

Helper library to quickly and easily create a CSV file in browser or Node

Installation

yarn add export-to-csv
// npm install --save export-to-csv

Usage

import { ExportToCsv } from 'export-to-csv';

var data = [
  {
    name: "Test 1",
    age: 13,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
  {
    name: 'Test 2',
    age: 11,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
  {
    name: 'Test 4',
    age: 10,
    average: 8.2,
    approved: true,
    description: "using 'Content here, content here' "
  },
];

  const options = { 
    fieldSeparator: ',',
    quoteStrings: '"',
    decimalseparator: '.',
    showLabels: true, 
    showTitle: true,
    title: 'My Awesome CSV',
    useBom: true,
    useKeysAsHeaders: true,
    // headers: ['Column 1', 'Column 2', etc...] <-- Won't work with useKeysAsHeaders present!
  };

const exportToCsv = new ExportToCsv(options);

API

Option Default Description
fieldSeparator , Defines the field separator character
filename 'generated' Defines the field separator character
quoteStrings " If provided, will use this characters to "escape" fields, otherwise will use double quotes as deafult
decimalseparator . Defines the decimal separator character (default is .). If set to "locale", it uses the language sensitive representation of the number.
showLabels false If true, the first row will be the headers option or object keys if useKeysAsHeaders is present
showTitle false
title 'My Generated Report' This string will be used as the report title
useBom true If true, adds a BOM character at the start of the CSV
useKeysAsHeaders false If true, this will use the keys of the first object in the collection as the column headers
headers [] Expects an array of strings, which is supplied, will be used as the column headers

Thanks!

Credits and Original Authors
javiertelioz
sn123
arf1980