ngryman / graceful-fs-stream

Graceful filesystem streams.

graceful-fs-stream

Graceful filesystem streams.

Provides both readable and writable filesystem streams that open files on first read or write.

Because stream producers are not always stream consumers, it can be useful to create a stream without worrying if data has ever been read or written.
gfs lazy opens or creates files. So it ensures a loose coupling between stream creation and file opening or creation. This can be useful in various use cases where you want to create streams without accessing the file system yet.

Installation

npm install graceful-fs-stream --production

Usage

var fs = require('graceful-fs-stream');

/** read stream */

var readable = fs.createReadStream(file);
// file is no yet open
readable.once('data', function() {
	// file was just open
});

/** write stream */

var writable = fs.createWriteStream(path);
// file is not yet open
writable.write('hey');
// file was just open

Note that if you try to close a stream directly, it won't crash badly.

Author

Nicolas Gryman

graceful-fs-stream's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.