Packages

c

io.scalajs.npm.csvparse

ParserOptions

class ParserOptions extends Object

Parser Options

Annotations
@RawJSType() @ScalaJSDefined()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParserOptions
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ParserOptions(delimiter: UndefOr[String] = js.undefined, rowDelimiter: UndefOr[String] = js.undefined, quote: UndefOr[String] = js.undefined, escape: UndefOr[String] = js.undefined, columns: UndefOr[|[|[Array[String], Boolean], Function]] = js.undefined, comment: UndefOr[String] = js.undefined, objname: UndefOr[String] = js.undefined, relax: UndefOr[Boolean] = js.undefined, relax_column_count: UndefOr[Boolean] = js.undefined, skip_empty_lines: UndefOr[Boolean] = js.undefined, max_limit_on_data_read: UndefOr[Int] = js.undefined, trim: UndefOr[Boolean] = js.undefined, ltrim: UndefOr[Boolean] = js.undefined, rtrim: UndefOr[Boolean] = js.undefined, auto_parse: UndefOr[Boolean] = js.undefined, auto_parse_date: UndefOr[Boolean] = js.undefined)

    delimiter

    Set the field delimiter. One character only. Defaults to "," (comma).

    rowDelimiter

    String used to delimit record rows or a special constant; special constants are 'auto', 'unix', 'mac', 'windows', 'unicode'; defaults to 'auto' (discovered in source or 'unix' if no source is specified).

    quote

    Optional: character surrounding a field. One character only. Defaults to double quote.

    escape

    Set the escape character. One character only. Defaults to double quote.

    columns

    (array|boolean|function) List of fields as an array, a user defined callback accepting the first line and returning the column names, or true if autodiscovered in the first CSV line. Defaults to null. Affects the result data set in the sense that records will be objects instead of arrays.

    comment

    Treat all the characters after this one as a comment. Defaults to "" (disabled).

    objname

    Name of header-record title to name objects by.

    relax

    Preserve quotes inside unquoted field.

    relax_column_count

    Discard inconsistent columns count. Default to false.

    skip_empty_lines

    Don't generate empty values for empty lines.

    max_limit_on_data_read

    Maximum numer of characters to be contained in the field and line buffers before an exception is raised. Used to guard against a wrong delimiter or rowDelimiter. Default to 128,000 characters.

    trim

    If true, ignore whitespace immediately around the delimiter. Defaults to false. Does not remove whitespace in a quoted field.

    ltrim

    If true, ignore whitespace immediately following the delimiter (i.e. left-trim all fields). Defaults to false. Does not remove whitespace in a quoted field.

    rtrim

    If true, ignore whitespace immediately preceding the delimiter (i.e. right-trim all fields). Defaults to false. Does not remove whitespace in a quoted field.

    auto_parse

    If true, the parser will attempt to convert input string to native types.

    auto_parse_date

    If true, the parser will attempt to convert input string to dates. It requires the "auto_parse" option. Be careful, it relies on Date.parse.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. var auto_parse: UndefOr[Boolean]
  6. var auto_parse_date: UndefOr[Boolean]
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. var columns: UndefOr[|[|[Array[String], Boolean], Function]]
  9. var comment: UndefOr[String]
  10. var delimiter: UndefOr[String]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. var escape: UndefOr[String]
  14. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  16. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  20. var ltrim: UndefOr[Boolean]
  21. var max_limit_on_data_read: UndefOr[Int]
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  25. var objname: UndefOr[String]
  26. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  27. var quote: UndefOr[String]
  28. var relax: UndefOr[Boolean]
  29. var relax_column_count: UndefOr[Boolean]
  30. var rowDelimiter: UndefOr[String]
  31. var rtrim: UndefOr[Boolean]
  32. var skip_empty_lines: UndefOr[Boolean]
  33. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  34. def toLocaleString(): String
    Definition Classes
    Object
  35. def toString(): String
    Definition Classes
    AnyRef → Any
  36. var trim: UndefOr[Boolean]
  37. def valueOf(): Any
    Definition Classes
    Object
  38. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped