crc32-stream
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/crc32-stream package

7.0.1 • Public • Published

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

Package Sidebar

Install

npm i crc32-stream

Weekly Downloads

12,139,582

Version

7.0.1

License

MIT

Unpacked Size

6.15 kB

Total Files

6

Last publish

Collaborators

  • ctalkington
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy