# @tsxper/crc32 > Calculates unsigned CRC32. Optimized Cycle Redundancy Check. Latest version **2.1.3** (published 2024-10-05) · MIT license · 0 weekly downloads ## Install ```sh npm install @tsxper/crc32 pnpm add @tsxper/crc32 yarn add @tsxper/crc32 bun add @tsxper/crc32 ``` ## Health **Score 40/100 (D)** — status: maintenance-mode. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: stale; low maintenance score. ## Facts | | | |---|---| | Version | 2.1.3 | | Published | 2024-10-05 | | First published | 2023-10-29 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 0 | | Unpacked size | 19.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Author | Vladyslav Babak | | Maintainers | vbabak | | Keywords | crc32, string, buffer, uint8array, file, readable, stream, typescript, commonjs, esm, cjs | ## Links - npm: https://www.npmjs.com/package/@tsxper/crc32 - Homepage: https://github.com/tsxper/crc32 - npm.io page: https://npm.io/package/@tsxper/crc32 ## Alternatives - [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads - [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads - [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads - [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads - [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads ## Recent versions - 2.1.3 (latest) — 2024-10-05 - 2.1.2 — 2023-12-23 - 2.1.1 — 2023-11-26 - 2.1.0 — 2023-11-19 - 2.0.1 — 2023-11-04 - 2.0.0 — 2023-11-04 - 1.0.5 — 2023-10-29 - 1.0.4 — 2023-10-29 - 1.0.3 — 2023-10-29 - 1.0.2 — 2023-10-29 ## README # CRC32 [![NPM Version](https://img.shields.io/npm/v/@tsxper/crc32.svg?style=flat-square)](https://www.npmjs.com/package/@tsxper/crc32) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](LICENSE) ![npm type definitions](https://img.shields.io/npm/types/@tsxper/crc32) [![NPM Downloads](https://img.shields.io/npm/dt/@tsxper/crc32.svg?style=flat-square)](https://www.npmjs.com/package/@tsxper/crc32) Cycle Redundancy Check 32 (CRC32). Calculates unsigned 32 bit checksum for ***0xEDB88320*** polynomial. Speed optimization is done through using pre-calculated values from lookup tables. [Release Notes](./NOTES.md). ### Performance Performance totally depends on the hardware. Results below are made on a very basic hardware with NodeJS v18.16.0, IntelCore i5 1.6 GHz CPU and DDR3 RAM. | Processor | Rate | CRC32OPS | Input | Time | | --- | --- | --- | --- | --- | | CRC32 | 1.2047 Gbit/s | 147059 | 10K random 1024-Bytes items | 68 msec | | CRC32Streams | 850.1594 Mbit/s | - | 100MB random data file | 941 msec | ### Compatibility ```JavaScript class CRC32 // Browser and NodeJS compatible. ``` ```JavaScript class CRC32Streams // Depends on NodeJS "stream" module. ``` ### TypeScript Support "@tsxper/crc32" package is originally written in TypeScript. TypeScript type definitions are included. ### UTF-8 Support UTF8 characters are fully supported. ```JavaScript crc32.calculate('español sí'); ``` ### Transitive Dependencies None. ## Example ### For String ```JavaScript const crc32 = new CRC32(); crc32.calculate('crc32 test'); // or crc32.forString('crc32 test'); ``` ### For Uint8Array ```JavaScript const crc32 = new CRC32(); crc32.forBytes(new TextEncoder().encode('crc32 test')); ``` ### For Buffer > Buffer extends Uint8Array. ```JavaScript const crc32 = new CRC32(); crc32.forBuffer(new TextEncoder().encode('crc32 test')); ``` ### For File ```JavaScript const crc32 = new CRC32Streams(); const checksum = await crc32.forFile(filePath); ``` ### Calculate CRC32 For String or File In Browser See "Compatibility". ***HTML Copy/Paste Example*** > This example also shows how to calculate CRC32 for ArrayBuffer. ```html

Calculating crc32 for text "hello crc32":

CRC32 of the file:

``` ### Customization. Calculate for chunks, chunk by chunk. For example, for sequence of events, converted into Uint8Array[] chunks. ```JavaScript const chunks = [new TextEncoder().encode('text1 text2')]; const crc32 = new CRC32(); let crc = 0; for (const chunk of chunks) { crc = crc32.forBytes(chunk, crc); } ``` ### Convert CRC32 decimal to hexadecimal ```JavaScript const crc32 = new CRC32(); const checksum10 = crc32.calculate("hi"); // 3633523372 const checksum16 = `0x${checksum10.toString(16)}`; // 0xd8932aac ``` ## Supporting CommonJS and ECMAScript modules Both, CommonJS and ESM modules are supported. ```JavaScript import { CRC32 } from '@tsxper/crc32'; // or const { CRC32 } = require('@tsxper/crc32'); ``` Supporting of the both module systems is done through "import", "require" and "default" conditions. ## License MIT License. ## Links + [Implementing CRC32 in TypeScript](https://medium.com/@vbabak/implementing-crc32-in-typescript-ff3453a1a9e7). + [Conditional exports, NodeJS](https://nodejs.org/api/packages.html#conditional-exports). + [Package exports, Webpack](https://webpack.js.org/guides/package-exports/). --- _Source: https://npm.io/package/@tsxper/crc32 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._