Class CSVLexer<Delimiter, Quotation>

CSV Lexer.

CSVLexer tokenizes CSV data into fields and records.

Type Parameters

Delimiter extends string = DEFAULT_DELIMITER
Quotation extends string = DEFAULT_QUOTATION

Index

Constructors

Methods

Constructors

constructor

new CSVLexer<Delimiter extends string = ",", Quotation extends string = "\"">(
options?: CommonOptions<Delimiter, Quotation> & AbortSignalOptions,
): CSVLexer<Delimiter, Quotation>
Constructs a new CSVLexer instance.
Type Parameters
- Delimiter extends string = ","
- Quotation extends string = "\""
Parameters
- options: CommonOptions<Delimiter, Quotation> & AbortSignalOptions = {}
  The common options for the lexer.
Returns CSVLexer<Delimiter, Quotation>
- Defined in src/CSVLexer.ts:61

Methods

lex

lex(chunk?: string, options?: CSVLexerLexOptions): IterableIterator<Token>
Lexes the given chunk of CSV data.
Parameters
- Optionalchunk: string
  The chunk of CSV data to be lexed. Omit to flush remaining data.
- Optionaloptions: CSVLexerLexOptions
  Lexer options.
Returns IterableIterator<Token>
An iterable iterator of tokens.
- Defined in src/CSVLexer.ts:91