Interface IReadStreamOptions

interface IReadStreamOptions {
    autoClose?: boolean;
    emitClose?: boolean;
    encoding?: BufferEncoding;
    end?: number;
    fd?: number | IFileHandle | null;
    flags?: TFlags;
    fs?: object | null;
    highWaterMark?: number;
    mode?: TMode;
    signal?: AbortSignal | null;
    start?: number;
}

Hierarchy (View Summary)

IOptions
- IReadStreamOptions

Index

Properties

autoClose? emitClose? encoding? end? fd? flags? fs? highWaterMark? mode? signal? start?

Properties

`Optional`autoClose

autoClose?: boolean

Defaults to true.

`Optional`emitClose

emitClose?: boolean

Defaults to true.

`Optional`encoding

encoding?: BufferEncoding

Defaults to null.

`Optional`end

end?: number

Defaults to Infinity.

`Optional`fd

fd?: number | IFileHandle | null

Defaults to null.

`Optional`flags

flags?: TFlags

Defaults to 'r'.

`Optional`fs

fs?: object | null

Defaults to null.

`Optional`highWaterMark

highWaterMark?: number

Defaults to 64 * 1024.

`Optional`mode

mode?: TMode

Defaults to 0o666

`Optional`signal

signal?: AbortSignal | null

Defaults to null.

`Optional`start

start?: number