Home > @rushstack/node-core-library > FileSystem > createReadStream
FileSystem.createReadStream() method
Creates a readable stream for an existing file. Behind the scenes it uses fs.createReadStream().
Signature:
static createReadStream(filePath: string): FileSystemReadStream;
Parameters
Parameter | Type | Description |
|---|---|---|
filePath | string | The path to the file. The path may be absolute or relative. |
Returns:
A new readable stream for the file.