Socket
Socket
Sign inDemoInstall

crc

Package Overview
Dependencies
0
Maintainers
1
Versions
30
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    crc

Various CRC JavaScript implementations


Version published
Maintainers
1
Install size
27.1 kB
Created

Package description

What is crc?

The crc npm package is used for generating cyclic redundancy check (CRC) codes for various input data. CRC is a popular method for detecting accidental changes to raw data in digital networks and storage devices. The package supports multiple CRC algorithms and can be used in various applications where data integrity is crucial.

What are crc's main functionalities?

CRC32 Calculation

This feature allows the calculation of CRC32 checksum for the input string 'hello world'. It is useful for verifying the integrity of strings or files.

const crc = require('crc');
const result = crc.crc32('hello world');
console.log('CRC32:', result);

CRC16 Calculation

This feature computes the CRC16 checksum for the given string. It's commonly used in telecommunications and storage for error-checking.

const crc = require('crc');
const result = crc.crc16('hello world');
console.log('CRC16:', result);

CRC1 Calculation

This feature calculates a simple CRC1 checksum, which can be used for basic error detection in scenarios where minimal data corruption checks are needed.

const crc = require('crc');
const result = crc.crc1('hello world');
console.log('CRC1:', result);

Other packages similar to crc

Readme

Source

crc

GitTip Dependency status devDependency Status Build Status

NPM

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)

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.

Keywords

FAQs

Last updated on 12 Nov 2014

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc