Skip to content

jamescostian/stream-string

Repository files navigation

stream-string

GitHub Workflow Status License NPM Version Downloads/Month

"Converts" a stream to a string. Promises are used by default, callbacks are allowed as well.

Installation

Assuming you have Node, you can just run:

npm install --save stream-string 

Usage

Promises

const fs = require("fs"); const ss = require("stream-string"); // Make a gzip stream (just for this example) const myStream = fs .createReadStream("./file") .pipe(require("zlib").createGzip()); ss(myStream) .then((data) => { // myStream was converted to a string, and that string is stored in data console.log(data); }) .catch((err) => { // myStream emitted an error event (err), so the promise from stream-string was rejected throw err; });

Callbacks

const fs = require("fs"); const ss = require("stream-string"); // Make a gzip stream (just for this example) const myStream = fs .createReadStream("./file") .pipe(require("zlib").createGzip()); ss(myStream, (err, data) => { if (err) { // myStream emitted an error event (err), which was passed to the callback throw err; } else { // myStream was converted to a string, and that string is stored in data console.log(data); } });

Contributing

Contributions welcome! Please read the contributing guidelines first. Also, try to keep code coverage up - npm test will tell you the code coverage near the end of its output, not to mention the fact that it will first test your code 😃

License

ISC

About

"Converts" a stream to a string. Promises are used by default, callbacks are allowed as well.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published