class ReadStream
extends stream.Readable
Instances of fs.ReadStream are created and returned using the createReadStream function.
Properties Jump to heading
Jump to headingbytesRead: numberThe number of bytes that have been read so far.
Jump to headingpath: string | BufferThe path to the file the stream is reading from as specified in the first
argument to fs.createReadStream(). If path is passed as a string, thenreadStream.path will be a string. If path is passed as a Buffer, thenreadStream.path will be a
Buffer. If fd is specified, thenreadStream.path will be undefined.
Jump to headingpending: booleanThis property is true if the underlying file has not been opened yet,
i.e. before the 'ready' event is emitted.
Methods Jump to heading
Jump to headingaddListener(event: "close",listener: () => void,): thisevents.EventEmitter
- open
- close
- ready
Jump to headingaddListener(event: "data",listener: (chunk: Buffer | string) => void,): thisJump to headingaddListener(event: "end",listener: () => void,): thisJump to headingaddListener(event: "error",listener: (err: Error) => void,): thisJump to headingaddListener(event: "open",listener: (fd: number) => void,): thisJump to headingaddListener(event: "pause",listener: () => void,): thisJump to headingaddListener(event: "readable",listener: () => void,): thisJump to headingaddListener(event: "ready",listener: () => void,): thisJump to headingaddListener(event: "resume",listener: () => void,): thisJump to headingaddListener(event: string | symbol,listener: (...args: any[]) => void,): thisJump to headingclose(callback?: (err?: ErrnoException | null) => void): voidJump to headingon(event: "close",listener: () => void,): thisJump to headingon(event: "data",listener: (chunk: Buffer | string) => void,): thisJump to headingon(event: "end",listener: () => void,): thisJump to headingon(event: "error",listener: (err: Error) => void,): thisJump to headingon(event: "open",listener: (fd: number) => void,): thisJump to headingon(event: "pause",listener: () => void,): thisJump to headingon(event: "readable",listener: () => void,): thisJump to headingon(event: "ready",listener: () => void,): thisJump to headingon(event: "resume",listener: () => void,): thisJump to headingon(event: string | symbol,listener: (...args: any[]) => void,): thisJump to headingonce(event: "close",listener: () => void,): thisJump to headingonce(event: "data",listener: (chunk: Buffer | string) => void,): thisJump to headingonce(event: "end",listener: () => void,): thisJump to headingonce(event: "error",listener: (err: Error) => void,): thisJump to headingonce(event: "open",listener: (fd: number) => void,): thisJump to headingonce(event: "pause",listener: () => void,): thisJump to headingonce(event: "readable",listener: () => void,): thisJump to headingonce(event: "ready",listener: () => void,): thisJump to headingonce(event: "resume",listener: () => void,): thisJump to headingonce(event: string | symbol,listener: (...args: any[]) => void,): thisJump to headingprependListener(event: "close",listener: () => void,): thisJump to headingprependListener(event: "data",listener: (chunk: Buffer | string) => void,): thisJump to headingprependListener(event: "end",listener: () => void,): thisJump to headingprependListener(event: "error",listener: (err: Error) => void,): thisJump to headingprependListener(event: "open",listener: (fd: number) => void,): thisJump to headingprependListener(event: "pause",listener: () => void,): thisJump to headingprependListener(event: "readable",listener: () => void,): thisJump to headingprependListener(event: "ready",listener: () => void,): thisJump to headingprependListener(event: "resume",listener: () => void,): thisJump to headingprependListener(event: string | symbol,listener: (...args: any[]) => void,): thisJump to headingprependOnceListener(event: "close",listener: () => void,): thisJump to headingprependOnceListener(event: "data",listener: (chunk: Buffer | string) => void,): thisJump to headingprependOnceListener(event: "end",listener: () => void,): thisJump to headingprependOnceListener(event: "error",listener: (err: Error) => void,): thisJump to headingprependOnceListener(event: "open",listener: (fd: number) => void,): thisJump to headingprependOnceListener(event: "pause",listener: () => void,): thisJump to headingprependOnceListener(event: "readable",listener: () => void,): thisJump to headingprependOnceListener(event: "ready",listener: () => void,): thisJump to headingprependOnceListener(event: "resume",listener: () => void,): thisJump to headingprependOnceListener(event: string | symbol,listener: (...args: any[]) => void,): this