How to close a readable stream (before end)?

by

Edit: Good news! Starting with Node.js 8.0.0 readable.destroy is officially available: https://nodejs.org/api/stream.html#stream_readable_destroy_error

ReadStream.destroy

You can call the ReadStream.destroy function at any time.

var fs = require("fs");

var readStream = fs.createReadStream("lines.txt");
readStream
    .on("data", function (chunk) {
        console.log(chunk);
        readStream.destroy();
    })
    .on("end", function () {
        // This may not been called since we are destroying the stream
        // the first time "data" event is received
        console.log("All the data in the file has been read");
    })
    .on("close", function (err) {
        console.log("Stream has been destroyed and file has been closed");
    });

The public function ReadStream.destroy is not documented (Node.js v0.12.2) but you can have a look at the source code on GitHub (Oct 5, 2012 commit).

The destroy function internally mark the ReadStream instance as destroyed and calls the close function to release the file.

You can listen to the close event to know exactly when the file is closed. The end event will not fire unless the data is completely consumed.

Note that the destroy (and the close) functions are specific to fs.ReadStream. There are not part of the generic stream.readable “interface”.

More Related Contents:

  1. Check synchronously if file/directory exists in Node.js
  2. Error handling with node.js streams
  3. Get file name from absolute path in Nodejs?
  4. Node.js check if file exists
  5. Module not found: Can’t resolve ‘fs’ in Next.js application
  6. Get all files recursively in directories NodejS
  7. How to create full path with node’s fs.mkdirSync?
  8. Can’t resolve ‘fs’ using webpack and react
  9. Obtaining the hash of a file using the stream capabilities of crypto module (ie: without hash.update and hash.digest)
  10. Read file from aws s3 bucket using node fs
  11. How would I create a for-loop in Node.js
  12. How can I update NodeJS and NPM to their latest versions?
  13. ERR_HTTP_HEADERS_SENT: Cannot set headers after they are sent to the client
  14. How to separate routes on Node.js and Express 4?
  15. How to Polyfill node core modules in webpack 5
  16. What is the difference between –save and –save-dev?
  17. How to remove module after “require” in node.js?
  18. Extending TypeScript Global object in node.js
  19. Do I need dependency injection in NodeJS, or how to deal with …?
  20. How to deploy node app that uses grunt to heroku
  21. Deploy Nodejs on Heroku fails serving static files located in subfolders
  22. Nodejs: Async request with a list of URL
  23. How can I build my test suite asynchronously?
  24. convert streamed buffers to utf8-string
  25. How can I save multiple documents concurrently in Mongoose/Node.js?
  26. How to fix “FATAL ERROR: Ineffective mark-compacts near heap limit Allocation failed – JavaScript heap out of memory” error
  27. React Proxy error: Could not proxy request /api/ from localhost:3000 to http://localhost:8000 (ECONNREFUSED)
  28. Node.js: how to limit the HTTP request size and upload file size?
  29. Mongoose: ObjectId Comparisons fail inconsistently
  30. how do i create a non-blocking asynchronous function in node.js?

Leave a Comment