Class FlexibleStringCSVLexer<DelimiterType, Quotation, TrackLocation>

String CSV Lexer interface

StringCSVLexer tokenizes string CSV data into fields and records.

Type Parameters

DelimiterType extends string = DEFAULT_DELIMITER
Whether to include location information in tokens (default: false)
Quotation extends string = DEFAULT_QUOTATION
TrackLocation extends boolean = false

Implements

StringCSVLexer<TrackLocation>

Index

Constructors

Methods

Constructors

constructor

new FlexibleStringCSVLexer<
    DelimiterType extends string = ",",
    Quotation extends string = "\"",
    TrackLocation extends boolean = false,
>(
    options?: StringCSVLexerOptions<DelimiterType, Quotation, TrackLocation>,
): FlexibleStringCSVLexer<DelimiterType, Quotation, TrackLocation>
Type Parameters
- DelimiterType extends string = ","
- Quotation extends string = "\""
- TrackLocation extends boolean = false
Parameters
- options: StringCSVLexerOptions<DelimiterType, Quotation, TrackLocation> = {}
Returns FlexibleStringCSVLexer<DelimiterType, Quotation, TrackLocation>
- Defined in src/parser/models/FlexibleStringCSVLexer.ts:79

Methods

lex

lex(
chunk?: string,
options?: CSVLexerLexOptions,
): IterableIterator<Token<TrackLocation>>
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<TrackLocation>>
An iterable iterator of tokens.
Implementation of StringCSVLexer.lex
- Defined in src/parser/models/FlexibleStringCSVLexer.ts:167