get-csv

v3.0.3
Takes a path to a CSV file. Callbacks with an array of objects representing each row. A super-simple package designed for convenience.

A super-simple package that fetches a CSV file and parses its data into an object in one function.

Example

data.csv:

foo,bar
one,two

compile.js:

const getCSV = require('get-csv');
getCSV('data.csv')
  .then(rows => console.log(rows));

data will log as [{foo: "one", bar: "two"}].

You can pass a URL instead of a file path:

getCSV('http://www.path.to.my.doc.csv')
  .then(rows => /* some JS */);

You can also pass a stream:

getCSV(fs.createReadStream('data.csv'))
  .then(rows => /* some JS */);

Options

You can pass fast-csv parsing options as the second argument.

The headers option defaults to true when using getCSV, but you can override this by explicitly setting it false in the options argument. Like so:

getCSV('data.csv', {headers: false})
  .then(rows => console.log(rows));

Here, rows will log as [['foo','bar'],['one','two']].

Callbacks

getCSV also supports old-fashioned callbacks. Example:

getCSV('test.csv', function(err, data){
  /* some JS */
});
npm i get-csv

Metadata

  • ISC
  • Whatever
  • Chris Kirk
  • released 2/6/2017

Downloads

Maintainers