@webreflection/utils 0.2.11 → 0.2.12

package/README.md

@@ -8,6 +8,7 @@
 A [collection](./src/) of utility functions:
 
   * **[all](https://github.com/WebReflection/utils/tree/main/src#all)** - `Promise.all` via object destructuring
+  * **[ascii](https://github.com/WebReflection/utils/tree/main/src#ascii)** - basic string to buffer conversion (without validation)
   * **[bound-once](https://github.com/WebReflection/utils/tree/main/src#bound-once)** - to retrieve unique bound methods per realm
   * **[bound](https://github.com/WebReflection/utils/tree/main/src#bound)** - to retrieve one-off bound methods
   * **[shared-array-buffer](https://github.com/WebReflection/utils/tree/main/src#shared-array-buffer)** - to simulate *SAB* when not available

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@webreflection/utils",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "type": "module",
   "types": {
     "./all": "./types/all.d.ts",
+    "./ascii": "./types/ascii.d.ts",
     "./bound-once": "./types/bound-once.d.ts",
     "./bound": "./types/bound.d.ts",
     "./shared-array-buffer": "./types/shared-array-buffer.d.ts",
@@ -15,6 +16,10 @@
       "types": "./types/all.d.ts",
       "import": "./src/all.js"
     },
+    "./ascii": {
+      "types": "./types/ascii.d.ts",
+      "import": "./src/ascii.js"
+    },
     "./bound-once": {
       "types": "./types/bound-once.d.ts",
       "import": "./src/bound-once.js"
@@ -39,6 +44,7 @@
   },
   "tests": [
     "all",
+    "ascii",
     "bound-once",
     "bound",
     "shared-array-buffer",

package/src/README.md

@@ -13,7 +13,7 @@ single object literal, it resolves each value and returns an object with the
 same keys.
 
 ```js
-import all from '@webreflection/all';
+import all from '@webreflection/utils/all';
 
 const user = await all({
   name: fetchName(),
@@ -28,6 +28,27 @@ positional array juggling required by `Promise.all`. For arrays, or for two or
 more arguments, it behaves like `Promise.all` and resolves to an array.
 
 
+## ascii
+
+An extremely small string to `Uint8Array` converter for known ASCII-compatible
+content. It does not validate or encode Unicode code points; it simply stores
+each string unit as its `0-255` char code.
+
+This is meant for niche cases where the input is already constrained, such as
+ISO date strings, plain-English global names or method names, and other small
+ad-hoc values.
+
+```js
+import { encode, decode } from '@webreflection/utils/ascii';
+
+console.log(decode(encode('ASCII')));
+// ASCII
+```
+
+Please note that decoding also fails for inputs bigger than about 64K bytes, or
+whatever argument limit your runtime has for `String.fromCharCode`.
+
+
 ## bound-once
 
 This is equivalent to **bound**, except each bound method is created only once. It is useful when bound method identity must be preserved across multiple calls.

package/src/ascii.js

@@ -0,0 +1,14 @@
+const { fromCharCode } = String;
+const toCharCode = Uint8Array.from.bind(Uint8Array);
+
+/**
+ * @param {string} str
+ * @returns
+ */
+export const encode = str => toCharCode(str, c => c.charCodeAt(0));
+
+/**
+ * @param {Uint8Array} view
+ * @returns {string}
+ */
+export const decode = view => fromCharCode(...view);

package/types/ascii.d.ts

@@ -0,0 +1,2 @@
+export function encode(str: string): Uint8Array<ArrayBuffer>;
+export function decode(view: Uint8Array): string;