Options
All
  • Public
  • Public/Protected
  • All
Menu

This is an interface describing the configuration options objects which are recognized when configuring Writer and Parser class instances. Note that missing options fields are filled using the default values in the global DefaultOptions object.

Hierarchy

  • Options

Index

Properties

Optional newline

newline: undefined | string

A string representing the row terminator, i.e. the newline string. Note that while Writer instances can write any row terminator whatsoever, the parser can handle only Unix-style "\n" and Windows-style "\r\n" row terminators. (And it can always handle both, even when both are alternately used in the same input CSV data.)

Optional quote

quote: undefined | string

Single UCS-2 character to use when quote-escaping fields.

Optional quoteAll

quoteAll: undefined | false | true

When set to true, all columns will be quoted when writing CSV output regardless of whether they contain special characters.

Optional separator

separator: undefined | string

Single UCS-2 character representing the column separator.

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc