Proposal: Stream support

[mikermcneil]

Proposed change

Add support for passing in writable streams to .outputFile and similar methods, e.g. usage:

require('fs-extra').outputFile('./foo.md', fs.createReadStream('./README.md'))

The PR implements a rough pass at this to outputFile(), just to capture the idea (no new tests, etc)

How it works currently

Currently, if you were to do:

require('fs-extra').outputFile('./foo.md', fs.createReadStream('./README.md'))

you get a file:

[object Object]

What does everyone think? @jprichardson would you be ok w/ something like this? I'm happy to send PRs, add tests, etc.

To try it

$ npm install fs-extra@git://github.com/mikermcneil/node-fs-extra.git#patch-1

Stuff that probably needs to be added

• Obviously tests
• Check that the stream is an instanceof Writable not just Stream
• Might even want to check that the writable stream hasn't been opened yet (not sure how to do this off-hand but I don't think it would be hard to do)

[mikermcneil]

@jprichardson and an aside- thanks so much for putting this together. It's one of my favorite modules and our team is using fs-extra in most of our projects, esp. sails and most recently sails-generate.

[jprichardson]

Thanks for the kind words! I'm in favor of it, although it does feel kinda weird, but I understand the point of wanting the destination directory path to exist before the file is written and having the convenience of passing the stream saves lines of code. Ya, I'm in favor. Add some tests and I'll include it! Thanks.

[jprichardson]

Closing this. As far as I can tell, this has been completed by #118 and https://github.com/jprichardson/node-fs-extra/releases/tag/0.17.0. If I missed something, please reopen or create a new issue. Thanks :)