Skip to content
This repository was archived by the owner on Jan 8, 2026. It is now read-only.

Latest commit

 

History

History
29 lines (21 loc) · 2.22 KB

File metadata and controls

29 lines (21 loc) · 2.22 KB

Home > @datashaper/schema > ParserOptions

ParserOptions interface

Parsing options for delimited files. This is a mix of the options from pandas and spark.

Signature:

export interface ParserOptions 

Properties

Property Modifiers Type Description
comment? string (Optional) Character that denotes a comment. Lines that begin with this character are ignored. Default: none.
delimiter? string (Optional) Column delimiter. Default: ,
escapeChar? string (Optional) String to use for escaping quotes. Default: none
header? boolean (Optional) Indicates that the first row of the file contains column header names. If false, names should be supplied, otherwise incrementing numbers will be assigned as header names. Default: true
lineTerminator? string (Optional) Character that indicates the end of a line (row). Default: \r, \r\n, or \n, and *must* be one of these.
names? string[] (Optional) List of column names to use. If this is not supplied, column names will be inferred from the first row of the data.
quoteChar? string (Optional) Character to use for quoting strings. Default: "
readRows? number (Optional) Number of rows to read from the data, starting at skip_rows (honors skipBlankLines). Default: Infinity
skipBlankLines? boolean (Optional) Skip blank lines when reading file. Default: true.
skipRows? number (Optional) Number of rows to skip from the start of the data (honors skipBlankLines). Default: 0