Interface CreateReadStreamOptions

interface CreateReadStreamOptions {
    autoClose?: boolean;
    emitClose?: boolean;
    encoding?: null | BufferEncoding;
    end?: number;
    highWaterMark?: number;
    signal?: AbortSignal;
    start?: number;
}

Hierarchy (View Summary)

EventEmitter.Abortable
- CreateReadStreamOptions

Index

Properties

autoClose? emitClose? encoding? end? highWaterMark? signal? start?

Properties

`Optional`autoClose

autoClose?: boolean

`Optional`emitClose

emitClose?: boolean

`Optional`encoding

encoding?: null | BufferEncoding

`Optional`end

end?: number

`Optional`highWaterMark

highWaterMark?: number

`Optional`signal

signal?: AbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

`Optional`start

start?: number