File: README.md

package info (click to toggle)
node-crc32 0.2.2-4
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 136 kB
  • sloc: javascript: 165; sh: 19; makefile: 5
file content (37 lines) | stat: -rw-r--r-- 909 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
Intro
=====

CRC means 'Cyclic Redundancy Check' and is a way to checksum data. It is a simple algorithm based on polynomials and is used in such projects as gzip.

This module only works with UTF-8 strings, and is meant to be able to work on node and in the browser.

This module also supports append mode (where a running crc sum is stored). Running in regular mode will reset the current crc sum.

Install
=======

To use in node:

`npm install crc32`

To use in the browser, use pakmanager.

API
===

    var crc32 = require('crc32');

	// runs on some string using a table
	crc32(someString);

	// runs on some string using direct mode
	crc32(someString, true);

	// directly run on someString using a table
	crc32.table(someString);

	// directly run on someString using a table in append mode
	crc32.table(someString, true);

	// directly run on someString using direct mode
	crc32.direct(someString);