Skip to content

createReadStream

createReadStream(this, path, options?): ReadStream

Defined in: src/node/async.ts:704

Opens a file in read mode and creates a Node.js-like ReadStream.

unknown

PathLike

The path to the file to be opened.

BufferEncoding | ReadStreamOptions

Options for the ReadStream and file opening (e.g., encoding, highWaterMark, mode).

ReadStream

A ReadStream object for interacting with the file’s contents.