Skip to main content

TakeReadStreamLinesOptions

Options for reading newline-delimited files.

Properties​

closeFileHandle?​

optional closeFileHandle: boolean;

Whether to close the file handle after completion.

Default​

true

fileHandle?​

optional fileHandle: FileHandle;

A file handle to use for reading the file. Useful for reusing a file handle across multiple reads.

lineLimit?​

optional lineLimit: number;

The maximum number of lines to yield. Useful for limiting the number of lines read from a file.

Default​

Infinity

newlineCharacter?​

optional newlineCharacter: string;

The character to use for newlines. Defaults to the system's newline character.