attebury / csv

A modern, fast, RFC 4180 compliant parser for JS

CSV

CSV is a universal JavaScript CSV parser designed specifically to be simple, fast, and spec compliant.

Features

• RFC Compliant
• ECMAScript Module
• CommonJS Compatible
• Typescript Compatible

Installation

npm install @vanillaes/csv

CSV.parse()

Takes a string of CSV data and converts it to a 2 dimensional array of [entries][values]

Arguments

CSV.parse(csv, {options}, reviver(value, row, col)) : [entries][values]

• csv - the CSV string to parse
• options
  • typed - infer types (default false)
• reviver¹ - a custom function to modify the output (default (value) => value)

¹ Values for row and col are 1-based.

Example

import { parse } from '@vanillaes/csv';
const csv = `
"header1,header2,header3"
"aaa,bbb,ccc"
"zzz,yyy,xxx"
`;
const parsed = parse(csv)
console.log(parsed);
> [
>   [ "header1", "header2", "header3" ],
>   [ "aaa", "bbb", "ccc" ],
>   [ "zzz", "yyy", "xxx" ]
> ]

CSV.stringify()

Takes a 2 dimensional array of [entries][values] and converts them to CSV

Arguments

CSV.stringify(array, {options}, replacer(value, row, col)) : string

• array - the input array to stringify
• options
  • eof - add a trailing newline at the end of file (default true)
• replacer¹ - a custom function to modify the values (default (value) => value)

¹ Values for row and col are 1-based.

Example

import { stringify } from '@vanillaes/csv';
const data = [
  [ "header1", "header2", "header3" ],
  [ "aaa", "bbb", "ccc" ],
  [ "zzz", "yyy", "xxx" ]
];
const stringified = stringify(data)
console.log(stringified);
> "header1,header2,header3"
> "aaa,bbb,ccc"
> "zzz,yyy,xxx"

CommonJS

A .cjs bundle is included for CommonJS compatibility

CSV.parse()

const CSV = require('@vanillaes/csv');
const csv = // the csv string
const data = CSV.parse(csv);

CSV.stringify()

const CSV = require('@vanillaes/csv');
const data = // the a 2-dimensional array
const csv = CSV.stringify(data);

Typescript

Typings are generated from JSDoc using Typescript. They are 100% compatible with VSCode Intellisense and will work seamlessly with Typescript.