@hugoalh/adler32 0.2.0 → 0.3.0

package/README.md

@@ -58,16 +58,17 @@ An ES (JavaScript & TypeScript) CLI and module to get the checksum of the data w
 - ```ts
   class Adler32 {
     constructor(data?: Adler32AcceptDataType);
+    get freezed(): boolean;
+    freeze(): this;
     hash(): bigint;
     hashBase16(): string;
     hashBase32Hex(): string;
     hashBase36(): string;
+    hashBigInt(): bigint;
     hashHex(): string;
     hashHexPadding(): string;
     hashNumber(): number;
     update(data: Adler32AcceptDataType): this;
-    static fromFile(filePath: string | URL): Promise<Adler32>;
-    static fromFileSync(filePath: string | URL): Adler32;
     static fromStream(stream: ReadableStream<Adler32AcceptDataType>): Promise<Adler32>;
   }
   ```

package/cli.js

@@ -1,6 +1,58 @@
 #!/usr/bin/env node
 import "./_dnt.polyfills.js";
 import * as dntShim from "./_dnt.shims.js";
+var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
+    if (value !== null && value !== void 0) {
+        if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
+        var dispose, inner;
+        if (async) {
+            if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
+            dispose = value[Symbol.asyncDispose];
+        }
+        if (dispose === void 0) {
+            if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
+            dispose = value[Symbol.dispose];
+            if (async) inner = dispose;
+        }
+        if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
+        if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
+        env.stack.push({ value: value, dispose: dispose, async: async });
+    }
+    else if (async) {
+        env.stack.push({ async: true });
+    }
+    return value;
+};
+var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
+    return function (env) {
+        function fail(e) {
+            env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
+            env.hasError = true;
+        }
+        var r, s = 0;
+        function next() {
+            while (r = env.stack.pop()) {
+                try {
+                    if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
+                    if (r.dispose) {
+                        var result = r.dispose.call(r.value);
+                        if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
+                    }
+                    else s |= 1;
+                }
+                catch (e) {
+                    fail(e);
+                }
+            }
+            if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
+            if (env.hasError) throw env.error;
+        }
+        return next();
+    };
+})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+});
 import { parseArgs } from "./deps/jsr.io/@std/cli/1.0.9/parse_args.js";
 import { Adler32 } from "./mod.js";
 if (!(import.meta.url === ("file:///" + process.argv[1].replace(/\\/g, "/")).replace(/\/{3,}/, "///"))) {
@@ -21,13 +73,24 @@ if (fromFile && fromStdin) {
     throw new SyntaxError(`Unable to use the sources of file and stdin together!`);
 }
 if (fromFile) {
-    if (argsValues.length === 0) {
-        throw new SyntaxError(`File path is not defined!`);
+    const env_1 = { stack: [], error: void 0, hasError: false };
+    try {
+        if (argsValues.length === 0) {
+            throw new SyntaxError(`File path is not defined!`);
+        }
+        if (argsValues.length !== 1) {
+            throw new SyntaxError(`Too many arguments! Expect: 1; Current: ${argsValues.length}.`);
+        }
+        const file = __addDisposableResource(env_1, await dntShim.Deno.open(argsValues[0]), false);
+        console.log((await Adler32.fromStream(file.readable)).hashHexPadding());
     }
-    if (argsValues.length !== 1) {
-        throw new SyntaxError(`Too many arguments! Expect: 1; Current: ${argsValues.length}.`);
+    catch (e_1) {
+        env_1.error = e_1;
+        env_1.hasError = true;
+    }
+    finally {
+        __disposeResources(env_1);
     }
-    console.log((await Adler32.fromFile(argsValues[0])).hashHexPadding());
 }
 else if (fromStdin) {
     if (argsValues.length !== 0) {

package/mod.d.ts

@@ -5,13 +5,24 @@ export type Adler32AcceptDataType = string | BigUint64Array | Uint8Array | Uint1
  */
 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);
     /**
-     * Get the checksum of the data, in big integer.
+     * 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;
@@ -30,6 +41,16 @@ export declare class Adler32 {
      * @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}
@@ -52,29 +73,7 @@ export declare class Adler32 {
      */
     update(data: Adler32AcceptDataType): this;
     /**
-     * Initialize from file, asynchronously.
-     *
-     * > **🛡️ Runtime Permissions**
-     * >
-     * > - File System - Read \[Deno: `read`; NodeJS (>= v20.9.0) 🧪: `fs-read`\]
-     * >   - *Resources*
-     * @param {string | URL} filePath Path of the file.
-     * @returns {Promise<Adler32>}
-     */
-    static fromFile(filePath: string | URL): Promise<Adler32>;
-    /**
-     * Initialize from file, synchronously.
-     *
-     * > **🛡️ Runtime Permissions**
-     * >
-     * > - File System - Read \[Deno: `read`; NodeJS (>= v20.9.0) 🧪: `fs-read`\]
-     * >   - *Resources*
-     * @param {string | URL} filePath Path of the file.
-     * @returns {Adler32}
-     */
-    static fromFileSync(filePath: string | URL): Adler32;
-    /**
-     * Initialize from readable stream, asynchronously.
+     * Initialize from the readable stream, asynchronously.
      * @param {ReadableStream<Adler32AcceptDataType>} stream Readable stream.
      * @returns {Promise<Adler32>}
      */

package/mod.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,CAAC;AAE7B,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,cAAc,GAAG,UAAU,GAAG,WAAW,GAAG,WAAW,CAAC;AACrG;;GAEG;AACH,qBAAa,OAAO;;IAInB;;;OAGG;gBACS,IAAI,CAAC,EAAE,qBAAqB;IAKxC;;;OAGG;IACH,IAAI,IAAI,MAAM;IAMd;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;OAGG;IACH,aAAa,IAAI,MAAM;IAGvB;;;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;;;;;;;;;OASG;WACU,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,OAAO,CAAC;IAI/D;;;;;;;;;OASG;IACH,MAAM,CAAC,YAAY,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,GAAG,OAAO;IAGpD;;;;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,OAAO,qBAAqB,CAAC;AAC7B,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;IAKD;;;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,MAAM;IAMd;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;OAGG;IACH,aAAa,IAAI,MAAM;IAGvB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;OAGG;IACH,UAAU,IAAI,MAAM;IAGpB;;;OAGG;IACH,cAAc,EAAE,MAAM,MAAM,CAAmB;IAC/C;;;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;IAWzC;;;;OAIG;WACU,UAAU,CAAC,MAAM,EAAE,cAAc,CAAC,qBAAqB,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;CAOxF;AACD,eAAe,OAAO,CAAC"}

package/mod.js

@@ -1,64 +1,15 @@
 import "./_dnt.polyfills.js";
-import * as dntShim from "./_dnt.shims.js";
-var __addDisposableResource = (this && this.__addDisposableResource) || function (env, value, async) {
-    if (value !== null && value !== void 0) {
-        if (typeof value !== "object" && typeof value !== "function") throw new TypeError("Object expected.");
-        var dispose, inner;
-        if (async) {
-            if (!Symbol.asyncDispose) throw new TypeError("Symbol.asyncDispose is not defined.");
-            dispose = value[Symbol.asyncDispose];
-        }
-        if (dispose === void 0) {
-            if (!Symbol.dispose) throw new TypeError("Symbol.dispose is not defined.");
-            dispose = value[Symbol.dispose];
-            if (async) inner = dispose;
-        }
-        if (typeof dispose !== "function") throw new TypeError("Object not disposable.");
-        if (inner) dispose = function() { try { inner.call(this); } catch (e) { return Promise.reject(e); } };
-        env.stack.push({ value: value, dispose: dispose, async: async });
-    }
-    else if (async) {
-        env.stack.push({ async: true });
-    }
-    return value;
-};
-var __disposeResources = (this && this.__disposeResources) || (function (SuppressedError) {
-    return function (env) {
-        function fail(e) {
-            env.error = env.hasError ? new SuppressedError(e, env.error, "An error was suppressed during disposal.") : e;
-            env.hasError = true;
-        }
-        var r, s = 0;
-        function next() {
-            while (r = env.stack.pop()) {
-                try {
-                    if (!r.async && s === 1) return s = 0, env.stack.push(r), Promise.resolve().then(next);
-                    if (r.dispose) {
-                        var result = r.dispose.call(r.value);
-                        if (r.async) return s |= 2, Promise.resolve(result).then(next, function(e) { fail(e); return next(); });
-                    }
-                    else s |= 1;
-                }
-                catch (e) {
-                    fail(e);
-                }
-            }
-            if (s === 1) return env.hasError ? Promise.reject(env.error) : Promise.resolve();
-            if (env.hasError) throw env.error;
-        }
-        return next();
-    };
-})(typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-});
 /**
  * Get the checksum of the data with algorithm Adler32.
  */
 export class Adler32 {
+    get [Symbol.toStringTag]() {
+        return "Adler32";
+    }
+    #freezed = false;
+    #hash = null;
     #a = 1n;
     #b = 0n;
-    #hash = null;
     /**
      * Initialize.
      * @param {Adler32AcceptDataType} [data] Data. Can append later via the method {@linkcode Adler32.update}.
@@ -69,7 +20,22 @@ export class Adler32 {
         }
     }
     /**
-     * Get the checksum of the data, in big integer.
+     * Whether the instance is freezed.
+     * @returns {boolean}
+     */
+    get freezed() {
+        return this.#freezed;
+    }
+    /**
+     * Freeze the instance to prevent any update.
+     * @returns {this}
+     */
+    freeze() {
+        this.#freezed = true;
+        return this;
+    }
+    /**
+     * Get the checksum of the data, in original format.
      * @returns {bigint}
      */
     hash() {
@@ -83,22 +49,34 @@ export class Adler32 {
      * @returns {string}
      */
     hashBase16() {
-        return this.hashNumber().toString(16).toUpperCase();
+        return this.hashBigInt().toString(16).toUpperCase();
     }
     /**
      * Get the checksum of the data, in Base32Hex ({@link https://datatracker.ietf.org/doc/html/rfc4648#section-7 RFC 4648 §7}).
      * @returns {string}
      */
     hashBase32Hex() {
-        return this.hashNumber().toString(32).toUpperCase();
+        return this.hashBigInt().toString(32).toUpperCase();
     }
     /**
      * Get the checksum of the data, in Base36.
      * @returns {string}
      */
     hashBase36() {
-        return this.hashNumber().toString(36).toUpperCase();
+        return this.hashBigInt().toString(36).toUpperCase();
+    }
+    /**
+     * 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 hex/hexadecimal without padding.
      * @returns {string}
@@ -126,6 +104,9 @@ export class Adler32 {
      * @returns {this}
      */
     update(data) {
+        if (this.#freezed) {
+            throw new Error(`Instance is freezed!`);
+        }
         this.#hash = null;
         for (const byte of ((typeof data === "string") ? new TextEncoder().encode(data) : data)) {
             this.#a = (this.#a + BigInt(byte)) % 65521n;
@@ -134,49 +115,12 @@ export class Adler32 {
         return this;
     }
     /**
-     * Initialize from file, asynchronously.
-     *
-     * > **🛡️ Runtime Permissions**
-     * >
-     * > - File System - Read \[Deno: `read`; NodeJS (>= v20.9.0) 🧪: `fs-read`\]
-     * >   - *Resources*
-     * @param {string | URL} filePath Path of the file.
-     * @returns {Promise<Adler32>}
-     */
-    static async fromFile(filePath) {
-        const env_1 = { stack: [], error: void 0, hasError: false };
-        try {
-            const file = __addDisposableResource(env_1, await dntShim.Deno.open(filePath), false);
-            return await Adler32.fromStream(file.readable);
-        }
-        catch (e_1) {
-            env_1.error = e_1;
-            env_1.hasError = true;
-        }
-        finally {
-            __disposeResources(env_1);
-        }
-    }
-    /**
-     * Initialize from file, synchronously.
-     *
-     * > **🛡️ Runtime Permissions**
-     * >
-     * > - File System - Read \[Deno: `read`; NodeJS (>= v20.9.0) 🧪: `fs-read`\]
-     * >   - *Resources*
-     * @param {string | URL} filePath Path of the file.
-     * @returns {Adler32}
-     */
-    static fromFileSync(filePath) {
-        return new this(dntShim.Deno.readFileSync(filePath));
-    }
-    /**
-     * Initialize from readable stream, asynchronously.
+     * Initialize from the readable stream, asynchronously.
      * @param {ReadableStream<Adler32AcceptDataType>} stream Readable stream.
      * @returns {Promise<Adler32>}
      */
     static async fromStream(stream) {
-        const instance = new Adler32();
+        const instance = new this();
         for await (const chunk of stream) {
             instance.update(chunk);
         }

package/package.json

@@ -1,9 +1,10 @@
 {
 	"name": "@hugoalh/adler32",
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"description": "A CLI and module to get the checksum of the data with algorithm Adler32.",
 	"keywords": [
-		"adler32"
+		"adler32",
+		"checksum"
 	],
 	"homepage": "https://github.com/hugoalh/adler32-es#readme",
 	"bugs": {