Global

Type Definitions

Definition

Data structure produced by the parser (per values-headers found).

Properties:
Name Type Description
headers Array.<string>

can be empty if no headers.
hlength int

number of headers.
values Array.<any>

can be empty if no values.
vlength int

number of values (rows).
Source:
Type:
  • Object

Options

Options to be configured in CSV.

By default:

const opts = {
  fail: function(m){
    console.log(m);
    return {
      fail: m,
    };
  },
  trim: true,
  trimEscaped: false,
  types: false,
  headers: true,
  firstLineHeader: false,
  delimiter: ',',
  escape: '"',
  comment: '#',
  cast: false,
  row: false,
};

If the cast function receives true it casts values that match the regexp /^[-+]?[\d.]+$/ to numbers. Those that do not match are not casted, so, they are considered strings.

The option firstLineHeader only works if headers is true.

The option headers only works if types is false (because types needs headers always).

The cast function receives this parameters:

  • value (any): the value (after the trimming, if applicable)
  • isHeader (bool): true if it is a header or not
  • type (string): type of the row (receives an empty string '' if types are not used)
  • column (int): the column index starting from 0 (the first)
  • row (int): the row index starting from 0 (the first).

And the value returned is inserted as the column value.

function cast(value, isHeader, type, column, row){
  // the return value is used for this column
}

The row function is not called for the headers and it receives this parameters:

  • value (any[]): array of values
  • type (string): type of the row (receives '' if no types)
  • definition (Definition{}): the global object with definitions (headers) and values so far
  • row (int): the row index starting from 0 (the first)

And if false is returned, the row is not inserted in values.

function row(value, type, definition, row){
  // if false is returned, the row is omitted
}
Properties:
Name Type Description
fail function

function to fail (error is capturable).
trim boolean

trim space in value (headers are always trimmed).
trimEscaped boolean

trim s
trimEscaped boolean

trim space in those escaped values (eg. " a " to "a").
types boolean

use types (allows multiple definitions per string).
headers boolean

you can omit headers when used with no types (flexible values).
firstLineHeader boolean

headers are in the first not empty line (and not commented).
delimiter char

column character delimiter.
escape char

column escape character.
comment char

comment char (omits the line).
cast boolean | function

cast function for every value (by default false: no casting).
row boolean | function

row function for every row values.
Source:
Type:
  • Object