CSV
A universal JavaScript CSV parser designed specifically to be simple, fast, and spec compliant
## Features
- RFC Compliant
- ECMAScript Module
- Typescript Compatible
## Imports
This package works isomorphically in browser and server-side JavaScript
### Browser
Import directly from the local path or a CDN
```html
```
The minified version can be imported from
```html
```
### Node
Install the package
```sh
npm install @vanillaes/csv
```
Import using the module path
```javascript
import { parse, stringify } from '@vanillaes/csv'
```
## Usage
### 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`)
- reviver1 - a custom function to modify the output (default `(value) => value`)
*1 Values for `row` and `col` are 1-based.*
#### Example
```javascript
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`)
- replacer1 - a custom function to modify the values (default `(value) => value`)
*1 Values for `row` and `col` are 1-based.*
#### Example
```javascript
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"
```
## Typescript
Typings are generated from JSDoc using Typescript. They are 100% compatible with VSCode Intellisense and will work seamlessly with Typescript.
