Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

105 lines (73 sloc) 3.754 kB
language layout title date comments sharing footer navigation github
en
page
Reading data from a source
2012-10-02 15:35:24 UTC
false
false
false
csv

The csv().from property provide functions to read to a csv input like a string, a file, a buffer or a readable stream. You may call the from function or one of its sub function. For example, here is to identical way to read from a file:

csv.from('/tmp/data.csv').on('data', console.log);
csv.from.path('/tmp/data.csv').on('data', console.log);

from(mixed)

Read from any sort of source. A convenient function to discover the source to parse. If it is a string, then if check if it match an existing file path and read the file content, otherwise, it treat the string as csv data. If it is an instance of stream, it consider the object to be an input stream. If is an array, then for each line should correspond a record.

Here's some examples on how to use this function

csv()
.from('"1","2","3","4","5"')
.on('end', function(){ console.log('done') })

csv()
.from('./path/to/file.csv')
.on('end', function(){ console.log('done') })

csv()
.from(fs.createReadStream('./path/to/file.csv'))
.on('end', function(){ console.log('done') })

csv()
.from(['"1","2","3","4","5"',['1','2','3','4','5']])
.on('end', function(){ console.log('done') })

from.options([options])

Update and retrieve options relative to the input source. Return the options as an object if no argument is provided.

  • delimiter Set the field delimiter, one character only, defaults to comma.
  • quote Set the field delimiter, one character only, defaults to double quotes.
  • escape Set the field delimiter, one character only, defaults to double quotes.
  • columns List of fields or true if autodiscovered in the first CSV line, default to null. Impact the transform argument and the data event by providing an object instead of an array, order matters, see the transform and the columns sections for more details.
  • flags Used to read a file stream, default to the r charactere.
  • encoding Encoding of the read stream, defaults to 'utf8', applied when a readable stream is created.
  • trim If true, ignore whitespace immediately around the delimiter, defaults to false.
  • ltrim If true, ignore whitespace immediately following the delimiter (i.e. left-trim all fields), defaults to false.
  • rtrim If true, ignore whitespace immediately preceding the delimiter (i.e. right-trim all fields), defaults to false.

from.array(data, [options])

Read from an array. Take an array as first argument and optionally some options as a second argument. Each element of the array
represents a csv record. Those elements may be a string, a buffer, an array or an object.

from.string(data, [options])

Read from a string or a buffer. Take a string as first argument and optionally an object of options as a second argument. The string must be the complete csv data, look at the streaming alternative if your CSV is large.

from.path(path, [options])

Read from a file path. Take a file path as first argument and optionally an object of options as a second argument.

from.stream(stream, [options])

Read from a stream. Take a readable stream as first argument and optionally an object of options as a second argument.

Jump to Line
Something went wrong with that request. Please try again.