JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 12015
  • Score
    100M100P100Q128580F

Test that two readable streams are equal to each other.

Package Exports

  • stream-equal

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (stream-equal) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

node-stream-equal Build Status

Test that two readable streams are equal to each other.

Usage

var streamEqual = require('stream-equal');
var fs = require('fs');

var readStream1 = fs.createReadStream(file);
var readStream2 = fs.createReadStream(file);
streamEqual(readStream1, readStream2, function(err, equal) {
  console.log(equal); // true
});

Motive

Useful for testing. This method is faster and uses much less memory than buffering entire streams and comparing their content, specially for bigger files.

You could also get the hash sum of a stream to test it against another stream. But that would take up more CPU due to the hashing and would require the entire streams to be read if they are not equal.

API

streamEqual(readStream1, readStream2, callback(err, equal))

Will compare each data event on both streams, pausing when needed to keep them in sync. equal will be either true or false if there is no err.

Install

npm install stream-equal

Tests

Tests are written with mocha

npm test

License

MIT