diff options
Diffstat (limited to 'node_modules/crc/README.md')
| -rw-r--r-- | node_modules/crc/README.md | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/node_modules/crc/README.md b/node_modules/crc/README.md new file mode 100644 index 000000000..ca501f60f --- /dev/null +++ b/node_modules/crc/README.md @@ -0,0 +1,106 @@ +# crc + +[](https://www.gittip.com/alexgorbatchev/) +[](https://david-dm.org/alexgorbatchev/node-crc) +[](https://david-dm.org/alexgorbatchev/node-crc?type=dev) +[](https://travis-ci.org/alexgorbatchev/node-crc) + +[](https://npmjs.org/package/crc) + +Module for calculating Cyclic Redundancy Check (CRC) for Node.js and the Browser. + +# Important: Node >= 6.3.0 < 6.9.2 + +There's was a bug in Node [#9342](https://github.com/nodejs/node/issues/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](https://github.com/nodejs/node/pull/9341) was released in `6.9.2`. If you are upgrading and seeing odd CRC calculation mismatches, this might be the reason. + +## Features + +* Full test suite comparing values against reference `pycrc` implementation. +* 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(…)` + * CRC16 Kermit `crc.crc16kermit(…)` + * CRC16 XModem `crc.crc16xmodem(…)` + * CRC24 `crc.crc24(…)` + * CRC32 `crc.crc32(…)` + +## Installation + +``` +npm install crc +``` + +## Usage + +Calculate a CRC32: + +```js +var crc = require('crc'); + +crc.crc32('hello').toString(16); +// "3610a686" +``` + +Calculate a CRC32 of a file: + +```js +crc.crc32(fs.readFileSync('README.md', 'utf8')).toString(16); +// "127ad531" +``` + +Or using a `Buffer`: + +```js +crc.crc32(fs.readFileSync('README.md')).toString(16); +// "127ad531" +``` + +Incrementally calculate a CRC32: + +```js +value = crc.crc32('one'); +value = crc.crc32('two', value); +value = crc.crc32('three', value); +value.toString(16); +// "9e1c092" +``` + +## Running tests + +``` +npm test +``` + +## Thanks! + +[pycrc](http://www.tty1.net/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. |