3.7 KiB

Raw Blame History

crc

Module for calculating Cyclic Redundancy Check (CRC).

Features

Full test suite comparing values against reference pycrc implementation.
Version 3.x is 3x to 4x faster than version 2.x.
Pure JavaScript implementation, no dependencies.
Provides CRC Tables for optimized calculations.
Provides support for the following CRC algorithms:
- CRC1 crc.crc1(…)
- CRC8 crc.crc8(…)
- CRC8 1-Wire crc.crc81wire(…)
- CRC16 crc.crc16(…)
- CRC16 CCITT crc.crc16ccitt(…)
- CRC16 Modbus crc.crc16modbus(…)
- CRC24 crc.crc24(…)
- CRC32 crc.crc32(…)

IMPORTANT

If you've used crc module prior to version 2.x, you might have some inconsistentcies with the current implementation because it relied on very old code and wasn't checked against reference implementation. If you upgrading from 1.x, please take special care.

Support

Please support me on GitTip. I've spend days developing and grooming this module and hope to spend more time. If you have bitcoin, please use the QR code or this wallet address 1CZyBREeHTmy8C5zVGHZHPwqBuWFmEuUCQ:

Installation

npm install crc

Running tests

$ npm install
$ npm test

Usage Example

Calculate a CRC32:

var crc = require('crc');

crc.crc32('hello').toString(16);
# => "3610a686"

Calculate a CRC32 of a file:

crc.crc32(fs.readFileSync('README.md', 'utf8')).toString(16);
# => "127ad531"

Or using a Buffer:

crc.crc32(fs.readFileSync('README.md')).toString(16);
# => "127ad531"

Incrementally calculate a CRC32:

value = crc32('one');
value = crc32('two', value);
value = crc32('three', value);
value.toString(16);
# => "09e1c092"

Thanks!

pycrc library is which the source of all of the CRC tables.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

3.7 KiB Raw Blame History

crc