instrumentality 0.0.1 → 0.0.2

package/README.md

@@ -18,9 +18,9 @@ npm install git+https://github.com/clerkburk/ts-instrumentality.git
 ```
 then
 ```ts
-import * as isb from "ts-instrumentality" // Base
-import * as isn from "ts-instrumentality/dom" // Browser (if available)
-import * as isd from "ts-instrumentality/road" // Filesystem using Node.js (if available)
+import * as ins from "instrumentality" // Base
+import * as ind from "instrumentality/dom" // Browser (if available)
+import * as inr from "instrumentality/road" // Filesystem using Node.js (if available)
 ```
 thats literally it
 

package/dist/base.d.ts

@@ -57,8 +57,8 @@ export type Enumerate<N extends number, A extends number[] = []> = A['length'] e
  * @property {@link timer} - The initial timestamp when the benchmark was created or last reset.
  * @method {@link round} - Records the current elapsed time and restarts the timer.
  * @method {@link reset} - Resets the benchmark timer to the current time and clears recorded rounds.
- * @accessor {@link y} - Elapsed time in years (assuming 365.25 days per year).
- * @accessor {@link mn} - Elapsed time in months (assuming 30.44 days per month).
+ * @accessor {@link y} - Elapsed time in years.
+ * @accessor {@link mn} - Elapsed time in months.
  * @accessor {@link w} - Elapsed time in weeks.
  * @accessor {@link d} - Elapsed time in days.
  * @accessor {@link h} - Elapsed time in hours.
@@ -78,9 +78,9 @@ export declare class Benchmark {
     round(): void;
     /** Resets the benchmark timer to the current time and clears recorded rounds. */
     reset(): void;
-    /** Elapsed time in years (assuming 365.25 days per year). */
+    /** Elapsed time in years, assuming 12 28-day months per year. */
     get y(): number;
-    /** Elapsed time in months (assuming 30.44 days per month). */
+    /** Elapsed time in months, assuming each month has 28 days. */
     get mn(): number;
     /** Elapsed time in weeks. */
     get w(): number;
@@ -101,6 +101,7 @@ export declare class Benchmark {
     /** Elapsed time in picoseconds. */
     get ps(): number;
 }
+export { Benchmark as Bench, Benchmark as Timer, Benchmark as Stopwatch };
 /**
  * Helper type that represents a view of a Uint8Array, exposing only view methods and properties, along with a readonly index signature for accessing elements.
  */
@@ -114,7 +115,7 @@ export declare const BASE122_ILLEGAL_INDEX: Readonly<Record<number, number>>;
 /** Shortened payload marker used when escaping an illegal 7-bit value and no subsequent 7-bit chunk is available (the current chunk is reused as payload). */
 export declare const BASE122_SHORT: 7;
 /**
- * Encodes indexed data into a base-122 representation, going as low as 9% overhead for large datasets, making base-64 look pathetic in comparison with its 33% overhead.
+ * Encodes indexed data into a base-122 representation, going as low as 14% overhead for regular data, making base-64 look pathetic in comparison with its 33% overhead.
  * The encoding process packs 7 bits of data into each character, and uses a two-byte sequence for reserved characters to ensure that the output string remains valid.
  *
  * @remarks The high density of base-122 comes with the trade-off of not being able to use the output string in certain contexts, such as URLs or file names.
@@ -141,6 +142,5 @@ export declare function encode122(data_: ArrayLike<number>): string;
  * @throws If an invalid base-122 illegal index is encountered during decoding (shouldn't happen if the input was generated by {@link encode122}).
  * @see {@link encode122} for encoding data into base-122.
  */
-export declare function decode122(base122_: string): Uint8Array;
-export {};
+export declare function decode122(base122_: string): Uint8Array<ArrayBuffer>;
 //# sourceMappingURL=base.d.ts.map

package/dist/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,MAAO,SAAQ,KAAK;IAAY,IAAI,SAA0B;CAAE;AAK7E;;;;;;;;;GASG;AACH,wBAAsB,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,OAAO,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAazH;AAID;;;;;;GAMG;AACH,wBAAsB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB1E;AAID;;;;;GAKG;AACH,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,IACvD,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AAGhE;;;;;GAKG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAChD;IAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAAE,GAAG,UAAU,CAAC,CAAC,CAAC;CAAC,CAAC,QAAQ,CAAC,CAAA;AAGhD;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,IAC/D,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AAIrE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IACpB,uEAAuE;IACvE,MAAM,EAAE,MAAM,EAAE,CAAK;IACrB,qFAAqF;IACrF,KAAK,SAAoB;IACzB,+DAA+D;IAC/D,KAAK,SAAgE;IACrE,iFAAiF;IACjF,KAAK,SAAuD;IAC5D,6DAA6D;IAC7D,IAAI,CAAC,WAA0B;IAC/B,8DAA8D;IAC9D,IAAI,EAAE,WAAwB;IAC9B,6BAA6B;IAC7B,IAAI,CAAC,WAAwB;IAC7B,4BAA4B;IAC5B,IAAI,CAAC,WAAyB;IAC9B,6BAA6B;IAC7B,IAAI,CAAC,WAAyB;IAC9B,+BAA+B;IAC/B,IAAI,CAAC,WAAyB;IAC9B,+BAA+B;IAC/B,IAAI,CAAC,WAA4B;IACjC,oCAAoC;IACpC,IAAI,EAAE,WAA4C;IAClD,oCAAoC;IACpC,IAAI,EAAE,WAA2B;IACjC,mCAAmC;IACnC,IAAI,EAAE,WAA2B;IACjC,mCAAmC;IACnC,IAAI,EAAE,WAA2B;CAClC;AAID;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,EACxC,IAAI,GACJ,UAAU,GACV,SAAS,GACT,aAAa,GACb,MAAM,GACN,WAAW,GACX,UAAU,GACV,eAAe,GACf,OAAO,GACP,MAAM,GACN,SAAS,GACT,SAAS,GACT,MAAM,GACN,QAAQ,GACR,OAAO,MAAM,CAAC,QAAQ,GACtB,QAAQ,GACR,aAAa,GACb,MAAM,GACN,gBAAgB,GAChB,UAAU,GACV,KAAK,GACL,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,UAAU,GACV,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,YAAY,CACf,GAAG;IAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAA;AAIpC,yJAAyJ;AACzJ,eAAO,MAAM,eAAe,YAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAU,CAAA;AAC/D,iHAAiH;AACjH,eAAO,MAAM,qBAAqB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAOzD,CAAA;AACV,8JAA8J;AAC9J,eAAO,MAAM,aAAa,EAAG,CAAc,CAAA;AAG3C;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,MAAM,CAmC1D;AAID;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU,CAgCtD"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../src/base.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,MAAO,SAAQ,KAAK;IAAY,IAAI,SAA0B;CAAE;AAK7E;;;;;;;;;GASG;AACH,wBAAsB,KAAK,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,CAAC,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,OAAO,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,CAAC,CAAC,CAazH;AAID;;;;;;GAMG;AACH,wBAAsB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAgB1E;AAID;;;;;GAKG;AACH,KAAK,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,IACvD,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AAGhE;;;;;GAKG;AACH,MAAM,MAAM,GAAG,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,IAChD;IAAC,GAAG,UAAU,CAAC,CAAC,CAAC;IAAE,GAAG,UAAU,CAAC,CAAC,CAAC;CAAC,CAAC,QAAQ,CAAC,CAAA;AAGhD;;;;;GAKG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,IAC/D,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAA;AAIrE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,SAAS;IACpB,uEAAuE;IACvE,MAAM,EAAE,MAAM,EAAE,CAAK;IACrB,qFAAqF;IACrF,KAAK,SAAoB;IACzB,+DAA+D;IAC/D,KAAK,SAAgE;IACrE,iFAAiF;IACjF,KAAK,SAAuD;IAC5D,iEAAiE;IACjE,IAAI,CAAC,WAA0B;IAC/B,+DAA+D;IAC/D,IAAI,EAAE,WAAwB;IAC9B,6BAA6B;IAC7B,IAAI,CAAC,WAAwB;IAC7B,4BAA4B;IAC5B,IAAI,CAAC,WAAyB;IAC9B,6BAA6B;IAC7B,IAAI,CAAC,WAAyB;IAC9B,+BAA+B;IAC/B,IAAI,CAAC,WAAyB;IAC9B,+BAA+B;IAC/B,IAAI,CAAC,WAA4B;IACjC,oCAAoC;IACpC,IAAI,EAAE,WAA4C;IAClD,oCAAoC;IACpC,IAAI,EAAE,WAA2B;IACjC,mCAAmC;IACnC,IAAI,EAAE,WAA2B;IACjC,mCAAmC;IACnC,IAAI,EAAE,WAA2B;CAClC;AACD,OAAO,EAAE,SAAS,IAAI,KAAK,EAAE,SAAS,IAAI,KAAK,EAAE,SAAS,IAAI,SAAS,EAAE,CAAA;AAIzE;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,EACxC,IAAI,GACJ,UAAU,GACV,SAAS,GACT,aAAa,GACb,MAAM,GACN,WAAW,GACX,UAAU,GACV,eAAe,GACf,OAAO,GACP,MAAM,GACN,SAAS,GACT,SAAS,GACT,MAAM,GACN,QAAQ,GACR,OAAO,MAAM,CAAC,QAAQ,GACtB,QAAQ,GACR,aAAa,GACb,MAAM,GACN,gBAAgB,GAChB,UAAU,GACV,KAAK,GACL,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,UAAU,GACV,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,YAAY,CACf,GAAG;IAAE,QAAQ,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAA;CAAE,CAAA;AAIpC,yJAAyJ;AACzJ,eAAO,MAAM,eAAe,YAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAU,CAAA;AAC/D,iHAAiH;AACjH,eAAO,MAAM,qBAAqB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAOzD,CAAA;AACV,8JAA8J;AAC9J,eAAO,MAAM,aAAa,EAAG,CAAc,CAAA;AAG3C;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC,GAAG,MAAM,CAmC1D;AAID;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,QAAQ,EAAE,MAAM,2BAgCzC"}

package/dist/base.js

@@ -62,8 +62,8 @@ export async function sleep(ms_, abs_) {
  * @property {@link timer} - The initial timestamp when the benchmark was created or last reset.
  * @method {@link round} - Records the current elapsed time and restarts the timer.
  * @method {@link reset} - Resets the benchmark timer to the current time and clears recorded rounds.
- * @accessor {@link y} - Elapsed time in years (assuming 365.25 days per year).
- * @accessor {@link mn} - Elapsed time in months (assuming 30.44 days per month).
+ * @accessor {@link y} - Elapsed time in years.
+ * @accessor {@link mn} - Elapsed time in months.
  * @accessor {@link w} - Elapsed time in weeks.
  * @accessor {@link d} - Elapsed time in days.
  * @accessor {@link h} - Elapsed time in hours.
@@ -83,9 +83,9 @@ export class Benchmark {
     round() { this.rounds.push(this.ms); this.timer = performance.now(); }
     /** Resets the benchmark timer to the current time and clears recorded rounds. */
     reset() { this.rounds = []; this.timer = performance.now(); }
-    /** Elapsed time in years (assuming 365.25 days per year). */
+    /** Elapsed time in years, assuming 12 28-day months per year. */
     get y() { return this.mn / 12; }
-    /** Elapsed time in months (assuming 30.44 days per month). */
+    /** Elapsed time in months, assuming each month has 28 days. */
     get mn() { return this.w / 4; }
     /** Elapsed time in weeks. */
     get w() { return this.d / 7; }
@@ -106,6 +106,7 @@ export class Benchmark {
     /** Elapsed time in picoseconds. */
     get ps() { return this.ns * 1e3; }
 }
+export { Benchmark as Bench, Benchmark as Timer, Benchmark as Stopwatch };
 /** Specific reserved 7-bit values codes that must be escaped when encoding data into base-122, as they are considered illegal in the encoding scheme. */
 export const BASE122_ILLEGAL = [0, 10, 13, 34, 38, 92];
 /** Mapping of illegal ascii codes to their corresponding indices in {@link BASE122_ILLEGAL} (reverse lookup). */
@@ -120,7 +121,7 @@ export const BASE122_ILLEGAL_INDEX = {
 /** Shortened payload marker used when escaping an illegal 7-bit value and no subsequent 7-bit chunk is available (the current chunk is reused as payload). */
 export const BASE122_SHORT = 0b111;
 /**
- * Encodes indexed data into a base-122 representation, going as low as 9% overhead for large datasets, making base-64 look pathetic in comparison with its 33% overhead.
+ * Encodes indexed data into a base-122 representation, going as low as 14% overhead for regular data, making base-64 look pathetic in comparison with its 33% overhead.
  * The encoding process packs 7 bits of data into each character, and uses a two-byte sequence for reserved characters to ensure that the output string remains valid.
  *
  * @remarks The high density of base-122 comes with the trade-off of not being able to use the output string in certain contexts, such as URLs or file names.

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "instrumentality",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/clerkburk/instrumentality.git"
+  },
   "type": "module",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "main": "./dist/base.js",
   "types": "./dist/base.d.ts",
   "devDependencies": {

package/src/base.ts

@@ -101,8 +101,8 @@ A['length'] extends N ? A[number] : Enumerate<N, [...A, A['length']]>
  * @property {@link timer} - The initial timestamp when the benchmark was created or last reset.
  * @method {@link round} - Records the current elapsed time and restarts the timer.
  * @method {@link reset} - Resets the benchmark timer to the current time and clears recorded rounds.
- * @accessor {@link y} - Elapsed time in years (assuming 365.25 days per year).
- * @accessor {@link mn} - Elapsed time in months (assuming 30.44 days per month).
+ * @accessor {@link y} - Elapsed time in years.
+ * @accessor {@link mn} - Elapsed time in months.
  * @accessor {@link w} - Elapsed time in weeks.
  * @accessor {@link d} - Elapsed time in days.
  * @accessor {@link h} - Elapsed time in hours.
@@ -122,9 +122,9 @@ export class Benchmark {
   round() { this.rounds.push(this.ms); this.timer = performance.now() }
   /** Resets the benchmark timer to the current time and clears recorded rounds. */
   reset() { this.rounds = []; this.timer = performance.now() }
-  /** Elapsed time in years (assuming 365.25 days per year). */
+  /** Elapsed time in years, assuming 12 28-day months per year. */
   get y() { return this.mn / 12 }
-  /** Elapsed time in months (assuming 30.44 days per month). */
+  /** Elapsed time in months, assuming each month has 28 days. */
   get mn() { return this.w / 4 }
   /** Elapsed time in weeks. */
   get w() { return this.d / 7 }
@@ -145,6 +145,7 @@ export class Benchmark {
   /** Elapsed time in picoseconds. */
   get ps() { return this.ns * 1e3 }
 }
+export { Benchmark as Bench, Benchmark as Timer, Benchmark as Stopwatch }
 
 
 
@@ -201,7 +202,7 @@ export const BASE122_SHORT = 0b111 as const
 
 
 /**
- * Encodes indexed data into a base-122 representation, going as low as 9% overhead for large datasets, making base-64 look pathetic in comparison with its 33% overhead.
+ * Encodes indexed data into a base-122 representation, going as low as 14% overhead for regular data, making base-64 look pathetic in comparison with its 33% overhead.
  * The encoding process packs 7 bits of data into each character, and uses a two-byte sequence for reserved characters to ensure that the output string remains valid.
  *
  * @remarks The high density of base-122 comes with the trade-off of not being able to use the output string in certain contexts, such as URLs or file names.
@@ -266,7 +267,7 @@ export function encode122(data_: ArrayLike<number>): string {
  * @throws If an invalid base-122 illegal index is encountered during decoding (shouldn't happen if the input was generated by {@link encode122}).
  * @see {@link encode122} for encoding data into base-122.
  */
-export function decode122(base122_: string): Uint8Array {
+export function decode122(base122_: string) {
   const out: number[] = []
   let current = 0
   let bitIndex = 0