1. module json-csv
   1. function json-csv.csv (options)
   2. function json-csv.csvBuffered (data, options, done)
   3. function json-csv.exporter (options)
   4. object json-csv.exporter.prototype
2. module json-csv.exporter
   1. function json-csv.exporter (options)
3. module json-csv.exporter.prototype
   1. function json-csv.exporter.prototype.csv (options)
   2. function json-csv.exporter.prototype.csvBuffered (data, options, done)
   3. function json-csv.exporter.prototype.getBodyRow (data)
   4. function json-csv.exporter.prototype.getHeaderRow ()
   5. function json-csv.exporter.prototype.getValue (data, arg)
   6. function json-csv.exporter.prototype.getValueIx (data, args, ix)
   7. function json-csv.exporter.prototype.prepValue (arg, forceQuoted)

module json-csv

function json-csv.csv (options)

• description and source-code

  csv = function (options) {
    return new exporter().csv(options)
  }

• example usage

  ...
  When using the streaming API, you'll need to also stream data into it.
  
  ```js
  var jsoncsv = require('json-csv')
  
  var readable_source = <something readable that emits data row by row>
  readable_source
    .pipe(jsoncsv.csv(options))
    .pipe(something_else_writable)
  ```
  
  
  ### Options
  ```js
  {
  ...

function json-csv.csvBuffered (data, options, done)

• description and source-code

  csvBuffered = function (data, options, done) {
    return new exporter().csvBuffered(data,options, done)
  }

• example usage

  ...
  Usage
  -----
  
  ### Buffered
  ```js
  var jsoncsv = require('json-csv')
  
  jsoncsv.csvBuffered(data, options, callback)
  ```
  
   - data : Array of JS objects
   - callback : returns buffered result (see below)
  
  ```js
  var callback = function(err,csv) {
  ...

function json-csv.exporter (options)

• description and source-code

  exporter = function (options) {
    this.options = options || {}
    this.fieldSeparator = this.options.fieldSeparator || ',';
  }

• example usage

  n/a

module json-csv.exporter

function json-csv.exporter (options)

• description and source-code

  exporter = function (options) {
    this.options = options || {}
    this.fieldSeparator = this.options.fieldSeparator || ',';
  }

• example usage

  n/a

module json-csv.exporter.prototype

function json-csv.exporter.prototype.csv (options)

• description and source-code

  csv = function (options) {
    var writtenHeader = false
    this.options = options || {}
    this.fieldSeparator = this.options.fieldSeparator || ',';
    var self = this;
  
    return es.through(function write(data) {
      if (!writtenHeader)
      {
        this.emit('data', self.getHeaderRow())
        writtenHeader = true
      }
      this.emit('data', self.getBodyRow(data))
    })
  }

• example usage

  ...
  When using the streaming API, you'll need to also stream data into it.
  
  ```js
  var jsoncsv = require('json-csv')
  
  var readable_source = <something readable that emits data row by row>
  readable_source
    .pipe(jsoncsv.csv(options))
    .pipe(something_else_writable)
  ```
  
  
  ### Options
  ```js
  {
  ...

function json-csv.exporter.prototype.csvBuffered (data, options, done)

• description and source-code

  csvBuffered = function (data, options, done) {
    if (!data) throw new Error("No data provided.")
  
    if(typeof options == 'function')
    {
      done = options
      options = {}
    }
  
    es.readArray(data)
      .pipe(this.csv(options))
      .pipe(concat(function(buffer) {
        done(null, buffer)
      }))
  }

• example usage

  ...
  Usage
  -----
  
  ### Buffered
  ```js
  var jsoncsv = require('json-csv')
  
  jsoncsv.csvBuffered(data, options, callback)
  ```
  
   - data : Array of JS objects
   - callback : returns buffered result (see below)
  
  ```js
  var callback = function(err,csv) {
  ...

function json-csv.exporter.prototype.getBodyRow (data)

• description and source-code

  getBodyRow = function (data) {
    var self = this
    var row = _.reduce(this.options.fields, function(line, field) {
      if (line === 'START') {
        line = '';
      } else {
        line += self.fieldSeparator
      }
      var val = self.getValue(data, field.name)
      if (field.filter) {
        val = field.filter(val)
      }
      if (typeof val !== 'undefined' && val !== null) {
        var quoted = typeof field.quoted !== 'undefined' && field.quoted
        line += self.prepValue(val.toString(), quoted)
      }
      return line
    }, 'START', self)
  
    row += '\r\n'
    return row
  }

• example usage

  ...
  
  return es.through(function write(data) {
    if (!writtenHeader)
    {
      this.emit('data', self.getHeaderRow())
      writtenHeader = true
    }
    this.emit('data', self.getBodyRow(data))
  })
  }
  
  exporter.prototype.prepValue = function(arg, forceQuoted) {
  var quoted = forceQuoted || arg.indexOf('"') >= 0 || arg.indexOf(this.fieldSeparator) >= 0 || arg.indexOf
  ('\n') >= 0
  var result = arg.replace(/\"/g,'""')
  if (quoted)
  ...

function json-csv.exporter.prototype.getHeaderRow ()

• description and source-code

  getHeaderRow = function () {
    var self = this
    var header = _.reduce(self.options.fields, function(line, field) {
      var label = field.label || field.name
      if (line === 'START') {
        line = '';
      } else {
        line += self.fieldSeparator
      }
      line += self.prepValue(label)
      return line
    }, 'START')
    header += '\r\n'
    return header
  }

• example usage

  ...
    this.options = options || {}
    this.fieldSeparator = this.options.fieldSeparator || ',';
    var self = this;
  
    return es.through(function write(data) {
      if (!writtenHeader)
      {
        this.emit('data', self.getHeaderRow())
        writtenHeader = true
      }
      this.emit('data', self.getBodyRow(data))
    })
  }
  
  exporter.prototype.prepValue = function(arg, forceQuoted) {
  ...

function json-csv.exporter.prototype.getValue (data, arg)

• description and source-code

  getValue = function (data, arg) {
    var args = arg.split('.')
    if (args.length > 0)
      return this.getValueIx(data, args, 0)
    return ""
  }

• example usage

  ...
  var self = this
  var row = _.reduce(this.options.fields, function(line, field) {
    if (line === 'START') {
      line = '';
    } else {
      line += self.fieldSeparator
    }
    var val = self.getValue(data, field.name)
    if (field.filter) {
      val = field.filter(val)
    }
    if (typeof val !== 'undefined' && val !== null) {
      var quoted = typeof field.quoted !== 'undefined' && field.quoted
      line += self.prepValue(val.toString(), quoted)
    }
  ...

function json-csv.exporter.prototype.getValueIx (data, args, ix)

• description and source-code

  getValueIx = function (data, args, ix) {
    if (!data)
      return ''
  
    //for filtered fields using the whole row as a source.
    //`this` is a keyword here; hoping not to conflict with existing fields.
    if (args[0] === "this")
      return data
  
    var val = data[args[ix]]
    if (typeof val === 'undefined')
      return ''
  
    //walk the dot-notation recursively to get the remaining values.
    if ((args.length-1) > ix)
      return this.getValueIx(val, args, ix+1);
  
    return val;
  }

• example usage

  ...
  row += '\r\n'
  return row
  }
  
  exporter.prototype.getValue = function(data, arg) {
  var args = arg.split('.')
  if (args.length > 0)
    return this.getValueIx(data, args, 0)
  return ""
  }
  
  exporter.prototype.getValueIx = function(data, args, ix) {
  if (!data)
    return ''
  ...

function json-csv.exporter.prototype.prepValue (arg, forceQuoted)

• description and source-code

  prepValue = function (arg, forceQuoted) {
    var quoted = forceQuoted || arg.indexOf('"') >= 0 || arg.indexOf(this.fieldSeparator) >= 0 || arg.indexOf('\n') >= 0
    var result = arg.replace(/\"/g,'""')
    if (quoted)
      result = '"' + result + '"'
    return result
  }

• example usage

  ...
    var header = _.reduce(self.options.fields, function(line, field) {
      var label = field.label || field.name
      if (line === 'START') {
        line = '';
      } else {
        line += self.fieldSeparator
      }
      line += self.prepValue(label)
      return line
    }, 'START')
    header += '\r\n'
    return header
  }
  
  exporter.prototype.getBodyRow = function(data) {
  ...