Interface CreateReadStreamOptions

interface CreateReadStreamOptions {
    bufferSize: number;
    errorTransformer?: ErrorTransformer;
    length?: number;
    limits?: {
        memory?: number;
        size?: number;
    };
    position?: number;
}

Hierarchy (view full)

Properties

bufferSize errorTransformer? length? limits? position?

Properties

bufferSize

bufferSize: number

The size of the buffer to use before sending to the stream.

Optional errorTransformer

errorTransformer?: ErrorTransformer

Allows to massage any possibly error that happens during reading.

Optional Readonly length

length?: number

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

Optional limits

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

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

Type declaration

  • Optional Readonly memory?: number
  • Optional Readonly size?: number

Optional Readonly position

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.

Settings

Member Visibility

Theme

On This Page

bufferSizeerrorTransformerlengthlimitsposition