connect-csvboy

Express/Connect middleware to threat requests with CSV contents

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
connect-csvboy
0.0.18 years ago8 years agoMinified + gzip package size for connect-csvboy in KB

Readme

connect-csvboy
Express middleware to check user access based on the ressources URIs and
HTTP methods.
NPM version Build status Dependency Status devDependency Status Coverage Status Code Climate

Usage

var csvboy = require('connect-csvboy');

// Add the middleware
app.use(csvboy());

// Consume the request
app.use(function(req, res, next) {
  // Pipe the request
  req.pipe(req.csvboy);

  // Consume the rows
  req.csvboy.on('readable', function() {
    var row;
    while(null !== (row = req.csvboy.read())) {
      console.log('New row:', row);
      // do whatever you want with the row (ex: insert in a db)
    }
  });
  req.csvboy.on('finish', function() {
    res.send(204);
  });

  // Threat errors
  req.csvboy.on('error', function(err) {
    req.unpipe(req.csvboy);
    next(err);
  });
});

API

reaccess(options)

options

Type: Object
The options of the reaccess middleware.

options.mimes

Type: Array Default: ['text/csv']
Mime type that csvboy should listen for.

options.methods

Type: Array Default: ['POST', 'PUT', 'PATCH']
HTTP methods that csvboy should listen for.

options.immediate

Type: Boolean Default: false
Immediatly pipe the request in the csv parser.

options.csvOptions

Type: Object
The CSV parser options. See the oh-csv README file.

Stats

NPM NPM