Neophobe Plebeian Mumpsimus
    Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    oh-csvpublic

    OH - CSV

    Simple and highly configurable CSV/TSV parser and encoder.

    NPM version Build status Dependency Status devDependency Status Coverage Status Code Climate

    Usage

    var csv = require('oh-csv');

    Parsing CSV

    var parser = new csv.Parser({
      sep: ',',
      linesep: ['\n', '\r', '\r\n'],
      quote: '"',
      esc: '\\'
    });
     
    parser.on('readable', function() {
      var row;
      while(row = parser.read()) {
        console.log(row);
      }
    });
     
    parser.write('1,Nicolas Froidure,nicolas.froidure@simplifield.com');
    // [1, 'Nicolas Froidure', 'nicolas.froidure@simplifield.com'] 
     
    parser.end();

    Alternatively, you can specify fields to map them to an object properties:

    var parser = new csv.Parser({
      fields: ['id', 'name', 'email'], // fields are required for this mode 
      sep: ',',
      linesep: ['\n', '\r', '\r\n'],
      quote: '"',
      esc: '\\'
    });
     
    parser.on('readable', function() {
      var row;
      while(row = parser.read()) {
        console.log(row);
      }
    });
     
    parser.write('1,Nicolas Froidure,nicolas.froidure@simplifield.com');
    // { 
    //  id: 1, 
    //  name: 'Nicolas Froidure', 
    //  email: 'nicolas.froidure@simplifield.com' 
    // } 
     
    parser.end();

    Encoding to CSV

    var encoder = new csv.Encoder({
      fields: ['id', 'name', 'email']
    });
     
    encoder.pipe(process.stdout);
     
    // Array form 
    encoder.write([1, 'Nicolas Froidure', 'nicolas.froidure@simplifield.com']);
    // '1,Nicolas Froidure,nicolas.froidure@simplifield.com' 
     
    // Object form (you need to specify fields) 
    encoder.write({
      id:1,
      email: 'nicolas.froidure@simplifield.com',
      name: 'Nicolas Froidure'
    });
    // '1,Nicolas Froidure,nicolas.froidure@simplifield.com' 

    Transforming CSV on the fly

    No library needed, DIY !

    var fs = require('fs');
    var parser = new csv.Parser();
    var encoder = new csv.Encoder();
     
    var Transform = require('stream').Transform;
    var transformer = new Transform({objectMode: true});
    transformer._transform = function(row, unused, cb) {
      row[name] = row[name].toLowerCase();
      this.push(row);
      cb();
    };
     
    fs.createReadStream('mycsv.csv')
      .pipe(parser)
      .pipe(transformer)
      .pipe(encoder)
      .pipe(fs.createWriteStream('mycsv.new.csv'));

    Excel compatible CSV

    We've added a simple wrapper to get a CSV stream compatible with Excel for both OSX and Windows from a csv.encoder instance:

      var encoder = new csv.Encoder(csv.tsvOpts);
    csv.wrapForExcel(encoder)
      .pipe(fs.createWriteStream('excel.csv'));

    Predefined options

    There are some CSV and TSV predefined objects in order to allow you to choose your format in a simpler manner.

    csv.csvOpts

    CSV (Comma-Separated Values) as it's commonly found.

    csv.tsvOpts

    TSV (Tabulation-Separated Values)

    csv.csvRFCOpts

    The RFC 4180 CSV format.

    API

    csv.Parser(options:Object)

    Create a new CSV Parser transform stream with options as defined in the options section.

    csv.Encoder(options:Object)

    Create a new CSV Encoder transform stream with options as defined in the options section.

    Options

    The options object is meant to be usable either with the Parser and the Encoder.

    options.sep:Array

    Default: [',']

    The strings used for separating values. The first string is used to encode CSV. Separators can have several chars (useless thus essential).

    options.linesep:Array

    Default: ['\r\n', '\r', '\n']

    The strings used for separating lines. The first string is used to encode CSV.

    options.quote:Array

    Default: ['"']

    The strings used for quoting values. The first string is used to encode CSV.

    options.toQuote:Array

    Default: An array containing options.sep, options.linesep strings.

    If a field contains any occurrence of the given strings, it must be quoted.

    options.esc:Array

    Default: ['\\']

    The strings used for escaping special chars. The first string is used to encode CSV.

    options.toEsc:Array

    Default: If options.esc is empty, an empty array. If options.quote is empty, an array containing options.sep, options.linesep, options.quote and options.esc strings, otherwise, an array containing options.quote and options.esc.

    The strings that must be escaped.

    install

    npm i oh-csv

    Downloadsweekly downloads

    235

    version

    1.0.2

    license

    BSD-2-Clause

    repository

    github.com

    last publish

    collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar