Some or all of the information on this page might not apply to Trusted Cloud by S3NS.

Interface CRC32CValidator (7.1.0)

An interface for CRC32C hashing and validation

Package

Properties

toString

toString: () => string;

A method returning the CRC32C as a base64-encoded string.

Example

Hashing the string 'data' should return 'rth90Q=='

js
const buffer = Buffer.from('data');
crc32c.update(buffer);
crc32c.toString(); // 'rth90Q=='

update

update: (data: Buffer) => void;

A method for passing Buffers for CRC32C generation.

Example

Hashing buffers from 'some ' and 'text\n'

js
const buffer1 = Buffer.from('some ');
crc32c.update(buffer1);

const buffer2 = Buffer.from('text\n');
crc32c.update(buffer2);

crc32c.toString(); // 'DkjKuA=='

validate

validate: (value: string) => boolean;

A method validating a base64-encoded CRC32C string.

Example

Should return true if the value matches, false otherwise

js
const buffer = Buffer.from('data');
crc32c.update(buffer);
crc32c.validate('DkjKuA=='); // false
crc32c.validate('rth90Q=='); // true