82f2b76e25
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.
79 lines
2.3 KiB
Markdown
79 lines
2.3 KiB
Markdown
# crc32-stream v2.0.0 [](https://travis-ci.org/archiverjs/node-crc32-stream) [](https://ci.appveyor.com/project/ctalkington/node-crc32-stream/branch/master)
|
|
|
|
crc32-stream is a streaming CRC32 checksumer. It uses [buffer-crc32](https://www.npmjs.org/package/buffer-crc32) behind the scenes to reliably handle binary data and fancy character sets. Data is passed through untouched.
|
|
|
|
### Install
|
|
|
|
```bash
|
|
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](http://nodejs.org/api/stream.html#stream_class_stream_transform) options and methods.
|
|
|
|
```js
|
|
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](http://nodejs.org/api/zlib.html#zlib_class_zlib_deflateraw) options and methods.
|
|
|
|
```js
|
|
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)
|
|
|
|
## Things of Interest
|
|
|
|
- [Changelog](https://github.com/archiverjs/node-crc32-stream/releases)
|
|
- [Contributing](https://github.com/archiverjs/node-crc32-stream/blob/master/CONTRIBUTING.md)
|
|
- [MIT License](https://github.com/archiverjs/node-crc32-stream/blob/master/LICENSE-MIT) |