base128-ascii 2.2.0 → 3.1.0

package/README.md

@@ -14,9 +14,11 @@ npm i base128-ascii
 import base128 from "base128-ascii"
 import fs from "fs"
 
-const encodedTemplate = base128.encode(fs.readFileSync("example.gz")).toJSTemplateLiterals()
+const input = fs.readFileSync("example.gz")
 
-const decoded = base128.decode(eval(encodedTemplate))
+const encodedTemplate = base128.encode(input).toJSTemplateLiterals()
+
+const decodedBytes = base128.decode(eval(encodedTemplate))
 ```
 
 ---

package/main.d.ts

@@ -1,14 +1,52 @@
-export declare class EncodeOutput {
-    constructor(out: Uint8Array);
-    uint8Array: Uint8Array;
+export declare class Base128Bytes {
+    constructor();
+    constructor(length: number);
+    constructor(array: ArrayLike<number>);
+    constructor<TArrayBuffer extends ArrayBufferLike = ArrayBuffer>(buffer: TArrayBuffer, byteOffset?: number, length?: number);
+    constructor(buffer: ArrayBuffer, byteOffset?: number, length?: number);
+    constructor(array: ArrayLike<number> | ArrayBuffer);
+
+    /**
+     * Returns a base128 string.
+     */
     toString(): string;
+
+    /**
+     * Returns a base128 [Template literals](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Template_literals).
+     */
     toJSTemplateLiterals(): string;
+
+    /**
+     * The ArrayBuffer instance referenced by the array.
+     */
+    get buffer(): ArrayBufferLike;
+
+    /**
+     * The length in bytes of the array.
+     */
+    get byteLength(): number;
+
+    /**
+     * The offset in bytes of the array.
+     */
+    get byteOffset(): number;
+
+    /**
+     * The length of the array.
+     */
+    get length(): number;
+
+    [index: number]: number;
 }
-export declare function encode(input: Uint8Array | string): EncodeOutput;
+
+export declare function encode(input: Uint8Array | string): Base128Bytes;
+
 export declare function decode(input: string): Uint8Array;
-declare const base128: {
-    EncodeOutput: typeof EncodeOutput;
-    encode: typeof encode;
-    decode: typeof decode;
+
+declare const base128 = {
+    Base128Bytes,
+    encode,
+    decode,
 };
+
 export default base128;

package/main.js

@@ -1,28 +1,30 @@
 //@ts-nocheck
 
-export class EncodeOutput {
-    /**
-     * @param {Uint8Array} out
-     */
-    constructor(out) {
-        this.uint8Array = out
+export const Base128Bytes = (() => {
+    class Base128Bytes {
+        constructor() {
+            return Reflect.construct(Uint8Array, arguments, Base128Bytes)
+        }
+        toString() {
+            return new TextDecoder().decode(this)
+        }
+        toJSTemplateLiterals() {
+            return `\`${this.toString().replace(
+                /[\r\\`]|\$\{|<\/script/g,
+                (match) => (
+                    match == '\r'
+                        ? '\\r'
+                        : match == '</script'
+                            ? '<\\/script'
+                            : '\\' + match
+                )
+            )}\``
+        }
     }
-    toString() {
-        return new TextDecoder().decode(this.uint8Array)
-    }
-    toJSTemplateLiterals() {
-        return `\`${this.toString().replace(
-            /[\r\\`]|\$\{|<\/script/g,
-            (match) => (
-                match == '\r'
-                    ? '\\r'
-                    : match == '</script'
-                        ? '<\\/script'
-                        : '\\' + match
-            )
-        )}\``
-    }
-}
+    const { buffer, byteLength, byteOffset, length } = Object.getOwnPropertyDescriptors(Object.getPrototypeOf(Uint8Array.prototype))
+    Object.defineProperties(Base128Bytes.prototype, { buffer, byteLength, byteOffset, length })
+    return Base128Bytes
+})()
 
 /**
  * @param {Uint8Array | string} input
@@ -31,7 +33,7 @@ export function encode(input) {
     if (typeof input == 'string')
         input = new TextEncoder().encode(input)
     var il = input.length
-        , out = new Uint8Array(Math.ceil(il / 7 * 8))
+        , out = new Base128Bytes(Math.ceil(il / 7 * 8))
         , ii = 0
         , oi = 0
     while (ii < il) {
@@ -48,7 +50,7 @@ export function encode(input) {
         /* 6 */ out[oi++] = (input[ii++] << 1 | input[ii] >> 7) & 127
         /* 7 */ out[oi++] = input[ii++] & 127
     }
-    return new EncodeOutput(out)
+    return out
 }
 
 /**
@@ -82,7 +84,7 @@ export function decode(input) {
 }
 
 export default {
-    EncodeOutput,
+    Base128Bytes,
     encode,
     decode
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "base128-ascii",
-  "version": "2.2.0",
+  "version": "3.1.0",
   "author": "bddjr",
   "license": "Unlicense",
   "type": "module",
@@ -10,7 +10,7 @@
     "main.d.ts"
   ],
   "scripts": {
-    "test": "es-check es6 --checkFeatures --module *.js && node scripts/test.mjs",
+    "test": "es-check es6 --checkFeatures --module main.js && node scripts/test.mjs",
     "prepublishOnly": "node --run test"
   },
   "repository": {