@stardazed/adler32

sd-adler32

Compute the Adler-32 checksum of a data stream.

Installation

⚠️ Important: This package, like everything in the @stardazed org, is distributed as an ES2015 module and is intended for use in browsers, not in NodeJS per se. Browser-specific types may be used.

yarn add @stardazed/adler32

or

npm install --save @stardazed/adler32

Usage

/**
 * Compute the Adler-32 checksum of a source.
 * This method will do its best to get a correct stream of unsigned bytes out
 * of the specified input, but take care when passing in basic arrays.
 * You can use `adler32Bytes` for the "I know what I'm doing" version.
 * @param data Source data, a string, array, TypedArray or ArrayBuffer
 * @param adler Optional seed for the checksum
 */
function adler32(data: string | number[] | TypedArray | DataView | ArrayBuffer, seed?: number): number;

/**
 * Compute the Adler-32 checksum of a sequence of unsigned bytes.
 * Make very sure that the individual elements in buf are all
 * in the UNSIGNED byte range (i.e. 0..255) otherwise the
 * result will be indeterminate.
 * @param buf Source data, an array-like of unsigned bytes
 * @param adler Optional seed for the checksum
 */
function adler32Bytes(buf: ArrayLike<number>, adler?: number): number;

Copyright

Copyright (C) 1995-2011, 2016 Mark Adler
Converted to TypeScript by Arthur Langereis (@zenmumbler)
from adler32.c, which can be found at:
https://github.com/madler/zlib/blob/master/adler32.c

License

zlib