@hugoalh/adler32 0.4.0 → 0.5.0

package/README.md

@@ -58,23 +58,19 @@ An ECMAScript (JavaScript & TypeScript) module to get the checksum of the data w
     constructor(data?: Adler32AcceptDataType);
     get freezed(): boolean;
     freeze(): this;
-    hash(): bigint;
-    hashBase16(): string;
-    hashBase32Hex(): string;
-    hashBase36(): string;
-    hashBase64(): string;
-    hashBase64URL(): string;
-    hashBigInt(): bigint;
-    hashBuffer(): Buffer;
+    hash(): Uint8Array;
     hashHex(): string;
-    hashHexPadding(): string;
-    hashNumber(): number;
     update(data: Adler32AcceptDataType): this;
-    static fromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<Adler32>;
+    updateFromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<this>;
   }
   ```
 - ```ts
-  type Adler32AcceptDataType = string | BigUint64Array | Uint8Array | Uint16Array | Uint32Array;
+  type Adler32AcceptDataType =
+    | string
+    | BigUint64Array
+    | Uint8Array
+    | Uint16Array
+    | Uint32Array;
   ```
 
 > [!NOTE]
@@ -85,6 +81,6 @@ An ECMAScript (JavaScript & TypeScript) module to get the checksum of the data w
 ## ✍️ Examples
 
 - ```ts
-  new Adler32("Wikipedia").hashHexPadding();
+  new Adler32("Wikipedia").hashHex();
   //=> "11E60398"
   ```

package/mod.d.ts

@@ -1,4 +1,3 @@
-import { Buffer } from "node:buffer";
 export type Adler32AcceptDataType = string | BigUint64Array | Uint8Array | Uint16Array | Uint32Array;
 /**
  * Get the checksum of the data with algorithm Adler32.
@@ -8,7 +7,7 @@ export declare class Adler32 {
     get [Symbol.toStringTag](): string;
     /**
      * Initialize.
-     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update}.
+     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update} and {@linkcode Adler32.updateFromStream}.
      */
     constructor(data?: Adler32AcceptDataType);
     /**
@@ -22,65 +21,15 @@ export declare class Adler32 {
      */
     freeze(): this;
     /**
-     * Get the checksum of the data, in original format.
-     * @returns {bigint}
+     * Get the checksum of the data, in Uint8Array.
+     * @returns {Uint8Array}
      */
-    hash(): bigint;
+    hash(): Uint8Array;
     /**
-     * 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 Base64.
-     * @returns {string}
-     */
-    hashBase64(): string;
-    /**
-     * Get the checksum of the data, in Base64URL.
-     * @returns {string}
-     */
-    hashBase64URL(): 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 Buffer.
-     * @returns {Buffer}
-     */
-    hashBuffer(): Buffer;
-    /**
-     * Get the checksum of the data, in hex/hexadecimal without padding.
+     * Get the checksum of the data, in hexadecimal with 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.
@@ -88,11 +37,11 @@ export declare class Adler32 {
      */
     update(data: Adler32AcceptDataType): this;
     /**
-     * Initialize from the readable stream.
-     * @param {ReadableStream<Adler32AcceptDataType>} stream Readable stream.
-     * @returns {Promise<Adler32>}
+     * Append data from the readable stream.
+     * @param {ReadableStream<Adler32AcceptDataType>} stream Data from the readable stream.
+     * @returns {Promise<this>}
      */
-    static fromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<Adler32>;
+    updateFromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<this>;
 }
 export default Adler32;
 //# sourceMappingURL=mod.d.ts.map

package/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,cAAc,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC;AACrG;;GAEG;AACH,qBAAa,OAAO;;IACnB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAUD;;;OAGG;gBACS,IAAI,CAAC,EAAE,qBAAqB;IAgBxC;;;OAGG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IACD;;;OAGG;IACH,MAAM,IAAI,IAAI;IAId;;;OAGG;IACH,IAAI,IAAI,MAAM;IAId;;;OAGG;IACH,UAAU,IAAI,MAAM;IAIpB;;;OAGG;IACH,aAAa,IAAI,MAAM;IAIvB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAIpB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAIpB;;;OAGG;IACH,aAAa,IAAI,MAAM;IAIvB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;OAGG;IACH,cAAc,EAAE,MAAM,MAAM,CAAmB;IAC/C;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;OAGG;IACH,OAAO,IAAI,MAAM;IAGjB;;;OAGG;IACH,cAAc,IAAI,MAAM;IAGxB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAQzC;;;;OAIG;WACU,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,qBAAqB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAOxF;AACD,eAAe,OAAO,CAAC"}
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["src/mod.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,qBAAqB,GAC9B,MAAM,GACN,cAAc,GACd,UAAU,GACV,WAAW,GACX,WAAW,CAAC;AACf;;GAEG;AACH,qBAAa,OAAO;;IACnB,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAMD;;;OAGG;gBACS,IAAI,CAAC,EAAE,qBAAqB;IAKxC;;;OAGG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IACD;;;OAGG;IACH,MAAM,IAAI,IAAI;IAId;;;OAGG;IACH,IAAI,IAAI,UAAU;IAalB;;;OAGG;IACH,OAAO,IAAI,MAAM;IASjB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,qBAAqB,GAAG,IAAI;IAazC;;;;OAIG;IACG,gBAAgB,CAAC,MAAM,EAAE,cAAc,CAAC,qBAAqB,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAMpF;AACD,eAAe,OAAO,CAAC"}

package/mod.js

@@ -1,4 +1,3 @@
-import { Buffer } from "node:buffer";
 /**
  * Get the checksum of the data with algorithm Adler32.
  */
@@ -7,34 +6,19 @@ export class Adler32 {
         return "Adler32";
     }
     #freezed = false;
-    #hash = null;
-    #hashBase16 = null;
-    #hashBase32Hex = null;
-    #hashBase36 = null;
-    #hashBase64 = null;
-    #hashBase64URL = null;
+    #hashHex = null;
+    #hashUint8Array = null;
     #a = 1n;
     #b = 0n;
     /**
      * Initialize.
-     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update}.
+     * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update} and {@linkcode Adler32.updateFromStream}.
      */
     constructor(data) {
         if (typeof data !== "undefined") {
             this.update(data);
         }
     }
-    #clearStorage() {
-        if (this.#freezed) {
-            throw new Error(`Instance is freezed!`);
-        }
-        this.#hash = null;
-        this.#hashBase16 = null;
-        this.#hashBase32Hex = null;
-        this.#hashBase36 = null;
-        this.#hashBase64 = null;
-        this.#hashBase64URL = null;
-    }
     /**
      * Whether the instance is freezed.
      * @returns {boolean}
@@ -51,92 +35,34 @@ export class Adler32 {
         return this;
     }
     /**
-     * Get the checksum of the data, in original format.
-     * @returns {bigint}
+     * Get the checksum of the data, in Uint8Array.
+     * @returns {Uint8Array}
      */
     hash() {
-        this.#hash ??= this.#b * 65536n + this.#a;
-        return this.#hash;
-    }
-    /**
-     * Get the checksum of the data, in Base16.
-     * @returns {string}
-     */
-    hashBase16() {
-        this.#hashBase16 ??= this.hashBigInt().toString(16).toUpperCase();
-        return this.#hashBase16;
-    }
-    /**
-     * Get the checksum of the data, in Base32Hex ({@link https://datatracker.ietf.org/doc/html/rfc4648#section-7 RFC 4648 §7}).
-     * @returns {string}
-     */
-    hashBase32Hex() {
-        this.#hashBase32Hex ??= this.hashBigInt().toString(32).toUpperCase();
-        return this.#hashBase32Hex;
-    }
-    /**
-     * Get the checksum of the data, in Base36.
-     * @returns {string}
-     */
-    hashBase36() {
-        this.#hashBase36 ??= this.hashBigInt().toString(36).toUpperCase();
-        return this.#hashBase36;
-    }
-    /**
-     * Get the checksum of the data, in Base64.
-     * @returns {string}
-     */
-    hashBase64() {
-        this.#hashBase64 ??= this.hashBuffer().toString("base64");
-        return this.#hashBase64;
-    }
-    /**
-     * Get the checksum of the data, in Base64URL.
-     * @returns {string}
-     */
-    hashBase64URL() {
-        this.#hashBase64URL ??= this.hashBuffer().toString("base64url");
-        return this.#hashBase64URL;
-    }
-    /**
-     * Get the checksum of the data, in big integer.
-     * @returns {bigint}
-     */
-    hashBigInt() {
-        return this.hash();
-    }
-    /**
-     * Get the checksum of the data, in big integer.
-     * @returns {bigint}
-     */
-    hashBigInteger = this.hashBigInt;
-    /**
-     * Get the checksum of the data, in Buffer.
-     * @returns {Buffer}
-     */
-    hashBuffer() {
-        return Buffer.from(this.hashBase16(), "hex");
+        if (this.#hashUint8Array === null) {
+            const hex = this.hashHex();
+            const bytes = [];
+            for (let index = 0; index < hex.length; index += 2) {
+                bytes.push(hex.slice(index, index + 2));
+            }
+            this.#hashUint8Array = Uint8Array.from(bytes.map((byte) => {
+                return Number.parseInt(byte, 16);
+            }));
+        }
+        return Uint8Array.from(this.#hashUint8Array);
     }
     /**
-     * Get the checksum of the data, in hex/hexadecimal without padding.
+     * Get the checksum of the data, in hexadecimal with padding.
      * @returns {string}
      */
     hashHex() {
-        return this.hashBase16();
-    }
-    /**
-     * Get the checksum of the data, in hex/hexadecimal with padding.
-     * @returns {string}
-     */
-    hashHexPadding() {
-        return this.hashHex().padStart(8, "0");
-    }
-    /**
-     * Get the checksum of the data, in number.
-     * @returns {number}
-     */
-    hashNumber() {
-        return Number(this.hash());
+        if (this.#hashHex === null) {
+            this.#hashHex = (this.#b * 65536n + this.#a).toString(16).toUpperCase().padStart(8, "0");
+            if (this.#hashHex.length !== 8) {
+                throw new Error(`Unexpected hash hex result \`${this.#hashHex}\`! Please submit a bug report.`);
+            }
+        }
+        return this.#hashHex;
     }
     /**
      * Append data.
@@ -144,24 +70,28 @@ export class Adler32 {
      * @returns {this}
      */
     update(data) {
-        this.#clearStorage();
-        for (const byte of ((typeof data === "string") ? new TextEncoder().encode(data) : data)) {
+        if (this.#freezed) {
+            throw new Error(`Instance is freezed!`);
+        }
+        this.#hashHex = null;
+        this.#hashUint8Array = null;
+        const dataFmt = (typeof data === "string") ? new TextEncoder().encode(data) : data;
+        for (const byte of dataFmt) {
             this.#a = (this.#a + BigInt(byte)) % 65521n;
             this.#b = (this.#b + this.#a) % 65521n;
         }
         return this;
     }
     /**
-     * Initialize from the readable stream.
-     * @param {ReadableStream<Adler32AcceptDataType>} stream Readable stream.
-     * @returns {Promise<Adler32>}
+     * Append data from the readable stream.
+     * @param {ReadableStream<Adler32AcceptDataType>} stream Data from the readable stream.
+     * @returns {Promise<this>}
      */
-    static async fromStream(stream) {
-        const instance = new this();
+    async updateFromStream(stream) {
         for await (const chunk of stream) {
-            instance.update(chunk);
+            this.update(chunk);
         }
-        return instance;
+        return this;
     }
 }
 export default Adler32;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hugoalh/adler32",
-	"version": "0.4.0",
+	"version": "0.5.0",
 	"description": "A module to get the checksum of the data with algorithm Adler32.",
 	"keywords": [
 		"adler32",