优化

schangxiang@126.com

2025-09-19 0821aa23eabe557c0d9ef5dbe6989c68be35d1fe

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# CRC32 Stream [![Build Status](https://travis-ci.org/archiverjs/node-crc32-stream.svg?branch=master)](https://travis-ci.org/archiverjs/node-crc32-stream) [![Build status](https://ci.appveyor.com/api/projects/status/sy60s39cmyvd60i3/branch/master?svg=true)](https://ci.appveyor.com/project/ctalkington/node-crc32-stream/branch/master)
 
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
const {CRC32Stream} = require('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
const {DeflateCRC32Stream} = require('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)