Interface FileReadStreamOptions

interface FileReadStreamOptions {
    length?: number;
    limits?: { memory?: number; size?: number };
    position?: number;
}

Properties

length?: number

Is an integer specifying how many bytes to read from the file. By default, all bytes will be read.

limits?: { memory?: number; size?: number }

If provided, the size of the file will be checked against the limits.

position?: number

Is an integer specifying where to begin reading from in the file. If position is undefined, data will be read from the current file position.