https://github.com/archiverjs/node-crc32-stream
a streaming CRC32 checksumer (now with deflate support)
https://github.com/archiverjs/node-crc32-stream
crc32 javascript nodejs stream
Last synced: 5 months ago
JSON representation
a streaming CRC32 checksumer (now with deflate support)
- Host: GitHub
- URL: https://github.com/archiverjs/node-crc32-stream
- Owner: archiverjs
- License: mit
- Created: 2014-03-30T16:13:03.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-05-01T18:22:09.000Z (5 months ago)
- Last Synced: 2025-05-14T05:26:28.308Z (5 months ago)
- Topics: crc32, javascript, nodejs, stream
- Language: JavaScript
- Homepage:
- Size: 188 KB
- Stars: 33
- Watchers: 4
- Forks: 13
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# CRC32 Stream
crc32-stream is a streaming CRC32 checksumer. It uses the [crc](https://www.npmjs.org/package/crc) module 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
import { CRC32Stream } from "crc32-stream";
const source = fs.createReadStream("file.txt");
const 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
import { DeflateCRC32Stream } from "crc32-stream";
const source = fs.createReadStream("file.txt");
const 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)