Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

crc32-stream

archiverjs48.4mMIT7.0.1TypeScript support: definitely-typed

a streaming CRC32 checksumer

crc32-stream, crc32, stream, checksum

readme

CRC32 Stream

crc32-stream is a streaming CRC32 checksumer. It uses the crc module 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.

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 options and methods.

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

Changelog

7.0.1October 13, 2024Diff

7.0.0October 13, 2024Diff

6.0.0February 28, 2024Diff

5.0.1February 28, 2024Diff

5.0.0September 2, 2023Diff

4.0.3September 2, 2023Diff

4.0.2February 3, 2021Diff

4.0.1November 18, 2020Diff

4.0.0July 18, 2020Diff

3.0.1August 2, 2019Diff

3.0.0April 29, 2019Diff

2.0.0February 13, 2017Diff

1.0.1January 12, 2016Diff

Release Archive