Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aichbauer/node-convert-csv-to-array
Convert a csv formatted string to an array
https://github.com/aichbauer/node-convert-csv-to-array
array converter csv csv-converter list nodejs values
Last synced: about 2 months ago
JSON representation
Convert a csv formatted string to an array
- Host: GitHub
- URL: https://github.com/aichbauer/node-convert-csv-to-array
- Owner: aichbauer
- License: mit
- Created: 2018-04-05T10:18:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-09-13T19:41:35.000Z (over 3 years ago)
- Last Synced: 2024-11-13T14:56:16.071Z (about 2 months ago)
- Topics: array, converter, csv, csv-converter, list, nodejs, values
- Language: JavaScript
- Size: 75.2 KB
- Stars: 7
- Watchers: 3
- Forks: 5
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# convert-csv-to-array
[](https://www.npmjs.com/package/convert-csv-to-array)
[](https://travis-ci.org/aichbauer/node-convert-csv-to-array)
[](https://codecov.io/gh/aichbauer/node-convert-csv-to-array)
> Convert a csv formatted string to an array
## Table of Contents
* [Why?](#why)
* [Installation](#installation)
* [Functions](#functions)
* [Usage](#usage)
* [License](#license)
## Why?
I needed a simple way to convert csv formatted string to an array to display it in a table component.
## Installation
```sh
$ npm i convert-csv-to-array -S
```
or
```sh
$ yarn add convert-csv-to-array
```
## Functions
Take a look into the [usage section](#usage) for a detailed example.
### convertCSVToArray
> Note: you can also use the default export.
This function converts a csv formatted string into an array of objects, or into an array of arrays.
#### Syntax
Returns a new array.
```js
const array = convertCSVToArray(data, options);
```
##### Parameters
* **data**: a csv formatted string
* **options**: a object
* holds three keys: **header**, **type** and **separator**
* **header**: either `true` or `false`, default: `true`
* **type**: either `'object'`or `'array'`, default: `'object'`
* **separator**: the character which is the separator in your csv formatted string, default: `','`
## Usage
Some examples on how to use this library.
```js
const { convertCSVToArray } = require('convert-csv-to-array');
const converter = require('convert-csv-to-array');
// would be a use input (upload) or read from a file
const data = 'number;first;last;handle\n1;Mark;Otto;@mdo\n2;Jacob;Thornton;@fat\n3;Larry;the Bird;@twitter\n';
/*
const arrayofArrays = [
['number', 'first', 'last', 'handle'],
[1, 'Mark', 'Otto', '@mdo'],
[2, 'Jacob', 'Thornton', '@fat'],
[3, 'Larry', 'the Bird', '@twitter'],
];
*/
const arrayofArrays = convertCSVToArray(data, {
type: 'array',
separator: ';', // use the separator you use in your csv (e.g. '\t', ',', ';' ...)
});
/*
const arrayofObjects = [
['number', 'first', 'last', 'handle'],
{
number: 1,
first: 'Mark',
last: 'Otto',
handle: '@mdo',
},
{
number: 2,
first: 'Jacob',
last: 'Thornton',
handle: '@fat',
},
{
number: 3,
first: 'Larry',
last: 'the Bird',
handle: '@twitter',
},
];
*/
const arrayofObjects = convertCSVToArray(data, {
separator: ';', // use the separator you use in your csv (e.g. '\t', ',', ';' ...)
});
/*
const arrayofArraysWithoutHeader = [
[1, 'Mark', 'Otto', '@mdo'],
[2, 'Jacob', 'Thornton', '@fat'],
[3, 'Larry', 'the Bird', '@twitter'],
];
*/
const arrayofArraysWithoutHeader = convertCSVToArray(data, {
header: false,
type: 'array',
separator: ';', // use the separator you use in your csv (e.g. '\t', ',', ';' ...)
});
/*
const arrayofObjectsWithoutHeader = [
{
number: 1,
first: 'Mark',
last: 'Otto',
handle: '@mdo',
},
{
number: 2,
first: 'Jacob',
last: 'Thornton',
handle: '@fat',
},
{
number: 3,
first: 'Larry',
last: 'the Bird',
handle: '@twitter',
},
];
*/
const arrayofObjectsWithoutHeader = convertCSVToArray(data, {
header: false,
separator: ';', // use the separator you use in your csv (e.g. '\t', ',', ';' ...)
});
```
## License
MIT © Lukas Aichbauer