An options object for initializing a delimiter-separated data model.


  • IOptions


data: string

The data source for the data model.

delimiter: string

The field delimiter, such as ',' or '\t'.


The field delimiter must be a single character.

header?: boolean

Whether the data has a one-row header.

initialRows?: number

The maximum number of initial rows to parse before doing a asynchronous full parse of the data. This should be greater than 0.

quote?: string

Quote character.


Quotes are escaped by repeating them, as in RFC 4180. The quote must be a single character.

quoteParser?: boolean

Whether to use the parser that can handle quoted delimiters.


Setting this to false uses a much faster parser, but assumes there are not any field or row delimiters that are quoted in fields. If this is not set, it defaults to true if any quotes are found in the data, and false otherwise.

rowDelimiter?: "\n" | "\r\n" | "\r"

Row delimiter.


Any carriage return or newline character that is not a delimiter should be in a quoted field, regardless of the row delimiter setting.

Generated using TypeDoc