包详细信息

stream-string

jamescostian3kISC2.0.4

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

convert, stream

自述文件

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 :smiley:

License

ISC

更新日志

stream-string change log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning.

v2.0.4 - 2023-12-03

Changed

  • Upgrade deps

v2.0.3 - 2019-01-05

Changed

  • Upgrade deps

v2.0.2 - 2019-08-31

Changed

  • Upgrade deps

v2.0.1 - 2018-08-08

Changed

  • Upgrade deps
  • Change tagline

v2.0.0 - 2016-12-22

Added

  • Code of Conduct
  • Added support for Node v6 and beyond

Changed

  • Use Jest for testing and code coverage
  • Switch from special JSHint rules to standard
  • Make project files slightly more in line with those from module-init
  • Switch from MIT to ISC

Removed

  • Support for versions of Node before v6

v1.0.2 - 2015-07-13

Added

  • Downloads/month badge on README
  • LICENSE
  • CONTRIBUTING.md

Changed

  • Updated dependencies

v1.0.1 - 2015-03-18

Added

  • 2 more tests

v1.0.0 - 2015-02-14

After using v0.1.0 for a while and updating some dependencies, this project was ready to be bumped to v1.0.0.

Changed

  • Run tests with make test or npm test

Removed

  • Gulp

v0.1.0 - 2014-10-31

Initial Release - the first stable version