Interface ReadLineOptions

Options for DataReader.readLine method.

interface ReadLineOptions {
    encoding?: string;
    includeEOL?: boolean;
    initialCapacity?: number;
    maxBytes?: number;
}

Hierarchy (View Summary)

Properties

encoding?: string

The text encoding. Defaults to encoding the reader was configured with.

includeEOL?: boolean

True to include EOL marker in returned line. Defaults to false.

initialCapacity?: number

The initial buffer capacity for creating the string bytes. The buffer size duplicates itself when full, so the higher this value is set the less buffer grows happen but the more memory is wasted for reading small lines. Defaults to 1024.

maxBytes?: number

The maximum number of bytes (not characters!) to read. Default is unlimited.