@hugoalh/adler32/mod.d.ts

A CLI and module to get the checksum of the data with algorithm Adler32.

import "./_dnt.polyfills.js";
export type Adler32AcceptDataType = string | BigUint64Array | Uint8Array | Uint16Array | Uint32Array;
/**
 * Get the checksum of the data with algorithm Adler32.
 */
export declare class Adler32 {
    #private;
    get [Symbol.toStringTag](): string;
    /**
     * Initialize.
     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update}.
     */
    constructor(data?: Adler32AcceptDataType);
    /**
     * Whether the instance is freezed.
     * @returns {boolean}
     */
    get freezed(): boolean;
    /**
     * Freeze the instance to prevent any update.
     * @returns {this}
     */
    freeze(): this;
    /**
     * Get the checksum of the data, in original format.
     * @returns {bigint}
     */
    hash(): bigint;
    /**
     * Get the checksum of the data, in Base16.
     * @returns {string}
     */
    hashBase16(): string;
    /**
     * Get the checksum of the data, in Base32Hex ({@link https://datatracker.ietf.org/doc/html/rfc4648#section-7 RFC 4648 §7}).
     * @returns {string}
     */
    hashBase32Hex(): string;
    /**
     * Get the checksum of the data, in Base36.
     * @returns {string}
     */
    hashBase36(): string;
    /**
     * Get the checksum of the data, in big integer.
     * @returns {bigint}
     */
    hashBigInt(): bigint;
    /**
     * Get the checksum of the data, in big integer.
     * @returns {bigint}
     */
    hashBigInteger: () => bigint;
    /**
     * Get the checksum of the data, in hex/hexadecimal without padding.
     * @returns {string}
     */
    hashHex(): string;
    /**
     * Get the checksum of the data, in hex/hexadecimal with padding.
     * @returns {string}
     */
    hashHexPadding(): string;
    /**
     * Get the checksum of the data, in number.
     * @returns {number}
     */
    hashNumber(): number;
    /**
     * Append data.
     * @param {Adler32AcceptDataType} data Data.
     * @returns {this}
     */
    update(data: Adler32AcceptDataType): this;
    /**
     * Initialize from the readable stream, asynchronously.
     * @param {ReadableStream<Adler32AcceptDataType>} stream Readable stream.
     * @returns {Promise<Adler32>}
     */
    static fromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<Adler32>;
}
export default Adler32;
//# sourceMappingURL=mod.d.ts.map