History

Florian Dold 82f2b76e25 Reorganize module loading. We now use webpack instead of SystemJS, effectively bundling modules into one file (plus commons chunks) for every entry point. This results in a much smaller extension size (almost half). Furthermore we use yarn/npm even for extension run-time dependencies. This relieves us from manually vendoring and building dependencies. It's also easier to understand for new developers familiar with node.		2017-04-24 16:14:29 +02:00
..
lib	Reorganize module loading.	2017-04-24 16:14:29 +02:00
LICENSE	add node_modules to address #4364	2016-10-10 03:43:44 +02:00
package.json	Reorganize module loading.	2017-04-24 16:14:29 +02:00
README.md	Reorganize module loading.	2017-04-24 16:14:29 +02:00

README.md

crc32-stream v2.0.0

crc32-stream is a streaming CRC32 checksumer. It uses buffer-crc32 behind the scenes to reliably handle binary data and fancy character sets. Data is passed through untouched.

Install

npm install crc32-stream --save

You can also use npm install https://github.com/archiverjs/node-crc32-stream/archive/master.tar.gz to test upcoming versions.

Usage

CRC32Stream

Inherits Transform Stream options and methods.

var CRC32Stream = require('crc32-stream');

var source = fs.createReadStream('file.txt');
var checksum = new CRC32Stream();

checksum.on('end', function(err) {
  // do something with checksum.digest() here
});

// either pipe it
source.pipe(checksum);

// or write it
checksum.write('string');
checksum.end();

DeflateCRC32Stream

Inherits zlib.DeflateRaw options and methods.

var DeflateCRC32Stream = require('crc32-stream').DeflateCRC32Stream;

var source = fs.createReadStream('file.txt');
var checksum = new DeflateCRC32Stream();

checksum.on('end', function(err) {
  // do something with checksum.digest() here
});

// either pipe it
source.pipe(checksum);

// or write it
checksum.write('string');
checksum.end();

Instance API

digest()

Returns the checksum digest in unsigned form.

hex()

Returns the hexadecimal representation of the checksum digest. (ie E81722F0)

size(compressed)

Returns the raw size/length of passed-through data.

If compressed is true, it returns compressed length instead. (DeflateCRC32Stream)