Blazingly fast CRC implementations for node.js and browser
Python JavaScript Shell C Makefile
Clone or download
Latest commit a16b8a6 Jul 26, 2018
Permalink
Failed to load latest commit information.
.vscode Adds eslint and prettier. Jul 13, 2018
benchmark Updates benchmarks. Jul 13, 2018
commonjs Moves ES6 files into the root and adds webpack test. Jul 15, 2018
lib Updates lib folder Jul 26, 2018
test Moves ES6 files into the root and adds webpack test. Jul 15, 2018
webpack-test Fixes `import crc from 'crc'` case. Jul 18, 2018
.babelrc move babel config to babelrc May 6, 2016
.eslintignore Adds eslint and prettier. Jul 13, 2018
.eslintrc.js Adds eslint and prettier. Jul 13, 2018
.gitignore ignoring WebStorm project directory Nov 10, 2014
.prettierrc.js Adds eslint and prettier. Jul 13, 2018
.travis.yml Restores old `require()` while maintaining ES6 modules. Jul 13, 2018
LICENSE Adds LICENSE file. Mar 25, 2014
README.md Fixes `import crc from 'crc'` case. Jul 18, 2018
crc1.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc16.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc16ccitt.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc16kermit.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc16modbus.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc16xmodem.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc17ccitt.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc17kermit.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc17modbus.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc17xmodem.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc24.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc32.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc8.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc81wire.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crc91wire.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
crcjam.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
create_buffer.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
define_crc.js Moves ES6 files into the root and adds webpack test. Jul 15, 2018
index.js Fixes `import crc from 'crc'` case. Jul 18, 2018
package-lock.json 3.8.0 Jul 26, 2018
package.json 3.8.0 Jul 26, 2018

README.md

crc

The module for calculating Cyclic Redundancy Check (CRC) for Node.js and the Browser.

Features

  • Full test suite comparing values against reference pycrc implementation.
  • Pure JavaScript implementation, no dependencies.
  • ES6 modules.
  • Provides CRC tables for optimized calculations.
  • Provides support for the following CRC algorithms:
    • CRC1 (crc1)
    • CRC8 (crc8)
    • CRC8 1-Wire (crc81wire)
    • CRC16 (crc16)
    • CRC16 CCITT (crc16ccitt)
    • CRC16 Modbus (crc16modbus)
    • CRC16 Kermit (crc16kermit)
    • CRC16 XModem (crc16xmodem)
    • CRC24 (crc24)
    • CRC32 (crc32)
    • CRCJAM (crcjam)

Installation

npm install crc

Usage

Calculate a CRC32 (recommended way):

import crc32 from 'crc/crc32';
crc32('hello').toString(16);
// "3610a686"

Import everything (this may bloat bundle size):

import crc from 'crc';
crc.crc32('hello').toString(16);
// "3610a686"

Or use CommonJS (compatability mode, no longer recommended):

const { crc32 } = require('crc');
crc32('hello').toString(16);
// "3610a686"

Calculate a CRC32 of a file:

crc32(fs.readFileSync('README.md', 'utf8')).toString(16);
// "127ad531"

Or using a Buffer:

crc32(fs.readFileSync('README.md', 'utf8')).toString(16);
// "127ad531"

Incrementally calculate a CRC32:

value = crc.crc32('one');
value = crc.crc32('two', value);
value = crc.crc32('three', value);
value.toString(16);
// "9e1c092"

Important: Node >= 6.3.0 < 6.9.2

There's was a bug in Node #9342 that affected CRC calculation if Buffer.split() is used (see issue discussion for details). This affected all version starting from 6.3.0 up to but not including 6.9.2. The patch #9341 was released in 6.9.2. If you are upgrading and seeing odd CRC calculation mismatches, this might be the reason.

Running tests

npm test

Thanks!

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

License

The MIT License (MIT)

Copyright (c) 2014 Alex Gorbatchev

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.