export-to-csv
v1.4.0TypeScript
Easily create CSV data from json collection
0/weekUpdated 1 years agoMITUnpacked: 27.9 KB
Published by alexcaza
npm install export-to-csvexport-to-csv | Export to CSV Mini Library
Like this library and want to support active development?
Small, simple, and single purpose. Zero dependencies, functionally inspired, and fairly well-typed.
If you're looking for a fully CSV-compliant, consistently maintained, whole-package library, I'd recommend looking elsewhere! (see alternatives section below)
If you want a lightweight, stable, easy-to-use basic CSV generation and download library, feel free to install.
Installation
``javascript`
npm install --save export-to-csv
Usage
This library was written with TypeScript in mind, so the examples will be in TS.
You can easily use this library in JavaScript as well. The bundle uses ES modules, which all modern browsers support.
You can also look at the integration tests for browser/JS use, and the unit tests to understand how the library functions.
$3
`typescript
import { mkConfig, generateCsv, download } from "export-to-csv";
// mkConfig merges your options with the defaults
// and returns WithDefaults
const csvConfig = mkConfig({ useKeysAsHeaders: true });
const mockData = [
{
name: "Rouky",
date: "2023-09-01",
percentage: 0.4,
quoted: '"Pickles"',
},
{
name: "Keiko",
date: "2023-09-01",
percentage: 0.9,
quoted: '"Cactus"',
},
];
// Converts your Array
// Get the button in your HTML
const csvBtn = document.querySelector("#csv");
// Add a click handler that will run the download function.download
// takes csvConfig and the generated CsvOutput
// from .`
csvBtn.addEventListener("click", () => download(csvConfig)(csv));
$3
`typescript
import { mkConfig, generateCsv, asString } from "export-to-csv";
import { writeFile } from "node:fs";
import { Buffer } from "node:buffer";
// mkConfig merges your options with the defaults
// and returns WithDefaults
const csvConfig = mkConfig({ useKeysAsHeaders: true });
const mockData = [
{
name: "Rouky",
date: "2023-09-01",
percentage: 0.4,
quoted: '"Pickles"',
},
{
name: "Keiko",
date: "2023-09-01",
percentage: 0.9,
quoted: '"Cactus"',
},
];
// Converts your Array
// Write the csv file to disk
writeFile(filename, csvBuffer, (err) => {
if (err) throw err;
console.log("file saved: ", filename);
});
`
$3
Note: this is only applicable to projects using Typescript. If you're using this library with Javascript, you might not run into this issue.
There might be instances where you want to use the result from generateCsv as a string instead of a CsvOutput type. To do that, you can use asString, which is exported from this library.
`typescript
import { mkConfig, generateCsv, asString } from "export-to-csv";
const csvConfig = mkConfig({ useKeysAsHeaders: true });
const addNewLine = (s: string): string => s + "\n";
const mockData = [
{
name: "Rouky",
date: "2023-09-01",
percentage: 0.4,
quoted: '"Pickles"',
},
{
name: "Keiko",
date: "2023-09-01",
percentage: 0.9,
quoted: '"Cactus"',
},
];
// Converts your Array
// This would result in a type error
// const csvOutputWithNewLine = addNewLine(csvOutput);
// ❌ => CsvOutput is not assignable to type string.
// This unpacks CsvOutput which turns it into a string before use
const csvOutputWithNewLine = addNewLine(asString(csvOutput));
`
The reason the CsvOutput type exists is to prevent accidentally passing in a string which wasn't formatted by generateCsv to the download function.
$3
A case for this would be using browser extension download methods _instead of_ the supplied download function. There may be scenarios where using a Blob might be more ergonomic.
`typescript
import { mkConfig, generateCsv, asBlob } from "export-to-csv";
// mkConfig merges your options with the defaults
// and returns WithDefaults
const csvConfig = mkConfig({ useKeysAsHeaders: true });
const mockData = [
{
name: "Rouky",
date: "2023-09-01",
percentage: 0.4,
quoted: '"Pickles"',
},
{
name: "Keiko",
date: "2023-09-01",
percentage: 0.9,
quoted: '"Cactus"',
},
];
// Converts your Array
// Generate the Blob from the CsvOutput
const blob = asBlob(csvConfig)(csv);
// Requires URL to be available (web workers or client scripts only)
const url = URL.createObjectURL(blob);
// Assuming there's a button with an id of csv in the DOM
const csvBtn = document.querySelector("#csv");
csvBtn.addEventListener("click", () => {
// Use Chrome's downloads API for extensions
chrome.downloads.download({
url,
body: csv,
filename: "chrome-extension-output.csv",
});
});
`
API
| Option | Default | Type | Description |
| ------------------- | -------------------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fieldSeparator | "," | string | Defines the field separator character |filename
| | "generated" | string | Sets the name of the file created from the download function |quoteStrings
| | false | boolean | Determines whether or not to quote strings (using quoteCharacter's value). Whether or not this is set, \r, \n, and fieldSeparator will be quoted. |quoteCharacter
| | '"' | string | Sets the quote character to use. |decimalSeparator
| | "." | string | Defines the decimal separator character (default is .). If set to "locale", it uses the language-sensitive representation of the number. |showTitle
| | false | boolean | Sets whether or not to add the value of title to the start of the CSV. (This is not supported by all CSV readers) |title
| | "My Generated Report" | string | The title to display as the first line of the CSV file. (This is not the name of the file [see filename]) |showColumnHeaders
| | true | boolean | Determines if columns should have headers. When set to false, the first row of the CSV will be data. |columnHeaders
| | [] | Array | Use this option if column/header order is important! Determines the headers to use as the first line of the CSV data. If the item is a string, it will be used for lookup in your collection AND as the header label. If the item is an object, key will be used for lookup, and displayLabel will be used as the header label. |useKeysAsHeaders
| | false | boolean | If set, the CSV will use the key names in your collection as headers. Warning: headers recommended for large collections. If set, it'll override the headers option. Column/header order also not guaranteed. Use headers only if order is important! |boolDisplay
| | {true: "TRUE", false: "FALSE"} | {true: string, false: string} | Determines how to display boolean values in the CSV. This only works for true and false. 1 and 0 will not be coerced and will display as 1 and 0. |useBom
| | true | boolean | Adds a byte order mark which is required by Excel to display CSVs, despite it not being necessary with UTF-8 🤷♂️ |useTextFile
| | false | boolean | _Deprecation warning. This will be removed in the next major version._ Will download the file as text/plain instead of text/csv and use a .txt vs .csv file extension. |fileExtension
| | csv | string | File extension to use. Currently, this only applies if useTextFile is false`. |
Alternatives
As mentioned above, this library is intentionally small and was designed to solve a very simple need. It was not originally designed to be fully CSV compliant, so many things you need _might_ be missing. I'm also not the most active on it (~7 year gap between updates). So, here are some alternatives with more support and that might be more fully featured.
- https://csv.js.org/
- https://www.papaparse.com/
Thanks!
This library was originally based on this library by Javier Telio
| Credits and Original Authors |
| :-------------------------------------------------- |
| javiertelioz |
| sn123 |
| arf1980 |