@pinemach/csv

@pinemach/csv

@pinemach/csv is a minimal, zero-dependency JavaScript package for writing and parsing CSV files pursuant to RFC 4180, written in TypeScript.

The @pinemach/csv package natively supports parsing and writing string data either eagerly or lazily, as well as via NodeJS streams.

You can read the full API documentation at pineapplemachine.github.io/csv-js/.

Installation

You can install this package with the package manager of your choice. For example,

npm install @pinemach/csv

You can then import and use the module like so:

const csv = require("@pinemach/csv"); // CommonJS

import * as csv from "@pinemach/csv"; // ES6 modules

Configuration

When parsing or writing CSV data, the library accepts an options object, either as the second argument to parse, write, or stream, or as the sole argument to the Parser or Writer constructor.

The CSV Parser class recognizes these configuration options:

const myCsvParser = new csv.Parser({
    separator: ",", // Column value separator character
    quote: "\"", // Column escaping/quoting character
});

The CSV Writer class recognizes these configuration options:

const myCsvWriter = new csv.Writer({
    separator: ",", // Column value separator character
    quote: "\"", // Column escaping/quoting character
    newline: "\r\n", // Row separator string, normally either "\n" or "\r\n"
    quoteAll: false, // Escape/quote all columns regardless of necessity
});

Example Usage

const assert = require("assert").strict;
const fs = require("fs");

const csv = require("@pinemach/csv");

// My table containing very important data
const data = [
    ["Continent", "Country", "Capital"],
    ["Africa", "Egypt", "Cairo"],
    ["Africa", "Morocco", "Rabat"],
    ["Asia", "China", "Beijing"],
    ["Asia", "Japan", "Tokyo"],
    ["Australia", "Australia", "Canberra"],
    ["Europe", "Britian", "London"],
    ["Europe", "Finland", "Helsinki"],
    ["North America", "Cuba", "Havana"],
    ["North America", "United States", "Washington"],
    ["South America", "Brazil", "Brasilia"],
    ["South America", "Ecuador", "Quito"],
];

// Write my data as a CSV file
const path = __dirname + "/basic-usage.csv";
fs.writeFileSync(path, csv.write(data));

// Load the data back from my CSV file
const content = fs.readFileSync(path, "utf8");
const parsedRows = csv.parse(content).rows();

// Parsed data is equivalent to the written data
assert.deepEqual(parsedRows, data);