Interface BinaryCSVLexer<TrackLocation>

Binary CSV Lexer interface

BinaryCSVLexer tokenizes binary CSV data (Uint8Array) into fields and records.

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

Type Parameters

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

Index

Methods

Methods

lex

lex(
chunk?: Uint8Array<ArrayBufferLike>,
options?: CSVLexerLexOptions,
): IterableIterator<Token<TrackLocation>>
Lexes the given chunk of CSV binary data.
Parameters
- Optionalchunk: Uint8Array<ArrayBufferLike>
  The chunk of CSV binary data (Uint8Array) 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:2109