Skip to content
Test that two readable streams are equal to each other.
JavaScript
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
test
.gitignore
.travis.yml
LICENSE
README.md
package.json

README.md

node-stream-equal

Test that two readable streams are equal to each other.

Build Status Dependency Status

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

Something went wrong with that request. Please try again.