Interface StringCSVLexer<TrackLocation>

String CSV Lexer interface

StringCSVLexer tokenizes string CSV data into fields and records.

interface StringCSVLexer<TrackLocation extends boolean = false> {
    lex(
        chunk?: string,
        options?: CSVLexerLexOptions,
    ): IterableIterator<Token<TrackLocation>>;
}

Type Parameters

TrackLocation extends boolean = false
Whether to include location information in tokens (default: false)

Implemented by

FlexibleStringCSVLexer

Index

Methods

lex

Methods

lex

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

Interface StringCSVLexer<TrackLocation>

Type Parameters

Implemented by

Index

Methods

Methods

lex

Parameters

Returns IterableIterator<Token<TrackLocation>>

Settings

On This Page