convert-csv-to-json

Table of Contents

• Description
• Support for JS & TS
• Prerequisites
• Install npm convert-csv-to-json package

+ [Generate JSON file](#generate-json-file)
+ [Generate Array of Object in JSON format](#generate-array-of-object-in-json-format)
+ [Generate Object with sub array](#generate-object-with-sub-array)
+ [Define field delimiter](#define-field-delimiter)
+ [Support Quoted Fields](#support-quoted-fields)
+ [Index header](#index-header)
+ [Empty rows](#empty-rows)
+ [Format property value by type](#format-property-value-by-type)
  - [Number](#number)
  - [Boolean](#boolean)
+ [Encoding](#encoding)

• Development
• CI CD github action
• License
• Buy me a Coffee

Description

[
 {
  "first_name": "Constantin",
  "last_name": "Langsdon",
  "email": "clangsdon0@hc360.com",
  "gender": "Male",
  "age": "96",
  "zip": "123",
  "registered": "true"
 },
 {
  "first_name": "Norah",
  "last_name": "Raison",
  "email": "nraison1@wired.com",
  "gender": "Female",
  "age": "32",
  "zip": "",
  "registered": "false"
 }
]

Support for JS & TS

Prerequisites

Install npm convert-csv-to-json package

Install

$ npm install convert-csv-to-json --save

$ npm install -g convert-csv-to-json

Usage

Generate JSON file

let csvToJson = require('convert-csv-to-json');

let fileInputName = 'myInputFile.csv'; 
let fileOutputName = 'myOutputFile.json';

csvToJson.generateJsonFileFromCsv(fileInputName,fileOutputName);

Generate Array of Object in JSON format

let csvToJson = require('convert-csv-to-json');

let json = csvToJson.getJsonFromCsv("myInputFile.csv");
for(let i=0; i<json.length;i++){
    console.log(json[i]);
}

Generate Object with sub array

firstName;lastName;email;gender;age;birth;sons
Constantin;Langsdon;clangsdon0@hc360.com;Male;96;10.02.1965;*diego,marek,dries*

csvToJson.parseSubArray('*',',')
            .getJsonFromCsv('myInputFile.csv');
``` 
The result will be:
```json
[
  {
  "firstName": "Constantin",
  "lastName": "Langsdon",
  "email": "clangsdon0@hc360.com",
  "gender": "Male",
  "age": "96",
  "birth": "10.02.1965",
  "sons": ["diego","marek","dries"]
}
]
``` 

#### Define field delimiter
A field delimiter is needed to split the parsed values. As default the field delimiter is the **semicolon** (**;**), this means that during the parsing when a **semicolon (;)** is matched a new JSON entry is created.
In case your CSV file has defined another field delimiter you have to call the function ```fieldDelimiter(myDelimiter)``` and pass it as parameter the field delimiter.

E.g. if your field delimiter is the comma **,** then:

```js
 csvToJson.fieldDelimiter(',')
        .getJsonFromCsv(fileInputName);

Support Quoted Fields

csvToJson.supportQuotedField(true)
           .getJsonFromCsv(fileInputName);

[
  {
      "firstName": "Constantin",
      "lastName": "Langsdon,Nandson,Gangson",
      "email": "clangsdon0@hc360.com"
    }
]
``` 

#### Index header
If the header is not on the first line you can define the header index like: 

```js
 csvToJson.indexHeader(3)
            .getJsonFromCsv(fileInputName);

csvToJson.formatValueByType()
           .getJsonFromCsv(fileInputName);

[
 {
  "first_name": "Constantin",
  "last_name": "Langsdon",
  "email": "clangsdon0@hc360.com",
  "gender": "Male",
  "age": 96,
  "zip": 123,
  "registered": true
 },
 {
  "first_name": "Norah",
  "last_name": "Raison",
  "email": "nraison1@wired.com",
  "gender": "Female",
  "age": 32,
  "zip": "",
  "registered": false
 }
]

"age": 32

"age": "32"
 ```
##### Boolean
The property **registered** is printed as 
```json
 "registered": true

"registered": "true"
 ```

#### Encoding
You can read and decode files with the following encoding:
 * utf8: 
  ```js
   csvToJson.utf8Encoding()
              .getJsonFromCsv(fileInputName);
  ```
 * ucs2:
  ```js
    csvToJson.ucs2Encoding()
              .getJsonFromCsv(fileInputName);
   ```
 * utf16le:
   ```js
     csvToJson.utf16leEncoding()
                .getJsonFromCsv(fileInputName);
    ```
 * latin1:
   ```js
     csvToJson.latin1Encoding()
                .getJsonFromCsv(fileInputName);
    ```
 * ascii:
   ```js
     csvToJson.asciiEncoding()
                .getJsonFromCsv(fileInputName);
    ```
 * base64:
   ```js
     csvToJson.base64Encoding()
                .getJsonFromCsv(fileInputName);
    ```
 * hex:
   ```js
     csvToJson.hexEncoding()
                .getJsonFromCsv(fileInputName);
    ```

### Chaining Pattern

The exposed API is implemented with the [Method Chaining Pattern](https://en.wikipedia.org/wiki/Method_chaining), which means that multiple methods can be chained, e.g.:

```js
let csvToJson = require('convert-csv-to-json');

csvToJson.fieldDelimiter(',')
          .formatValueByType()
          .parseSubArray("*",',')
          .supportQuotedField(true)
          .getJsonFromCsv('myInputFile.csv');

~~~
npm install
~~~

~~~
npm test
~~~

~~~
npm run test-debug
~~~

• MAJOR: new major relase, e.g. v1.0.0 -> v2.0.0
• PATCH: new patch relase, e.g. v1.0.0 -> v1.0.1
• without any of the above keywords a new minor relase will be applied, e.g. v1.0.0 -> v1.1.0

License

Buy me a Coffee

* **BTC** tip address: