[travis-image]: https://api.travis-ci.org/nestjs/nest.svg?branch=master
[travis-url]: https://travis-ci.org/nestjs/nest
[linux-image]: https://img.shields.io/travis/nestjs/nest/master.svg?label=linux
[linux-url]: https://travis-ci.org/nestjs/nest

A progressive Node.js framework for building efficient and scalable server-side applications, heavily inspired by Angular.

CSV Parser for NestJS

Nest framework TypeScript starter repository.

Wrapper for csv-parser library

Installation

``bash
$ npm install nest-csv-parser


or if you using Yarn


$ yarn add nest-csv-parser
`

Add nest-csv-parser as a dependency.

`js
import { Module } from '@nestjs/common'
import { CsvModule } from 'nest-csv-parser'
// ...imports of your app dependecies

@Module({
imports: [
CsvModule, // <-- add into imports
...
],
controllers: [ ... ],
providers: [ ... ]
})
export class AppModule {}
`

Usage

Parser will create instance of entity for each line in CSV stream.

`js
// app.parser.ts
import { Injectable } from '@nestjs/common'
import { CsvParser } from 'nest-csv-parser'

class Entity {
foo: string
bar: string
}

@Injectable()
export class AppService {
constructor(
private readonly csvParser: CsvParser
) {}

async parse() {
// Create stream from file (or get it from S3)
const stream = fs.createReadStream(__dirname + '/some.csv')
const entities: Entity[] = await csvParser.parse(stream, Entity)

return entities
}
}
`

API

csvParser.parse(stream, Entity, count, offset, csvConfig) has 5 parameters.

$3

required

First parameter has to be the stream of the CSV file. NodeJS Reference

$3

required

Has to be object from which will parser create instance.

$3

default: null

How many lines you want to parse.

$3

default: null

Offset is similar to SQL databases. Skips the N lines from the beginning of the file.

$3

default

`js
{ strict: true, separator: ';' }
`

Just a configuration object for csv-parser library options you can find here

Development

`bash


clone repository

$ git clone git@github.com:mCzolko/nest-csv-parser.git
$ cd nest-csv-parser

install dependencies

$ yarn install

watch mode

$ yarn test:watch
`

Test

`bash


unit tests


$ yarn test
``

Author

Michael Czolko