@helios-lang/codec-utils - npm Package Compare versions

Comparing version 0.1.18 to 0.1.19

package.json

 {
     "name": "@helios-lang/codec-utils",
-    "version": "0.1.18",
+    "version": "0.1.19",
     "description": "Primitive manipulation functions commonly used in encoding and decoding algorithms",
@@ -14,3 +14,6 @@ "main": "src/index.js",
         "prettify": "npx prettier . --write",
-        "test": "npx prettier . --check && tsc -p jsconfig.json --noEmit && node --test --experimental-test-coverage"
+        "test": "npm run test:pretty && npm run test:types && npm run test:suite",
+        "test:pretty": "npx prettier . --check",
+        "test:suite": "node --test --experimental-test-coverage",
+        "test:types": "tsc -p jsconfig.json --noEmit"
     },
@@ -17,0 +20,0 @@ "author": "Christian Schmitz",

src/bytes/base16.d.ts

@@ -16,2 +16,11 @@ /**
 /**
+ * @typedef {string | number[] | {bytes: number[]}} ByteArrayLike
+ */
+/**
+ * Permissive conversion to bytes
+ * @param {ByteArrayLike} b
+ * @returns {number[]}
+ */
+export function toBytes(b: ByteArrayLike): number[];
+/**
  * Converts a list of uint8 bytes into its hexadecimal string representation.
@@ -24,2 +33,5 @@ * @example
 export function bytesToHex(bytes: number[]): string;
+export type ByteArrayLike = string | number[] | {
+    bytes: number[];
+};
 //# sourceMappingURL=base16.d.ts.map

src/bytes/base16.js

@@ -48,2 +48,23 @@ import { padBits } from "../bits/index.js"
 /**
+ * @typedef {string | number[] | {bytes: number[]}} ByteArrayLike
+ */
+
+/**
+ * Permissive conversion to bytes
+ * @param {ByteArrayLike} b
+ * @returns {number[]}
+ */
+export function toBytes(b) {
+    if (Array.isArray(b)) {
+        return b
+    } else if (typeof b == "string") {
+        return hexToBytes(b)
+    } else if (typeof b == "object" && "bytes" in b) {
+        return b.bytes
+    } else {
+        throw new Error("not ByteArrayLike")
+    }
+}
+
+/**
  * Converts a list of uint8 bytes into its hexadecimal string representation.
@@ -50,0 +71,0 @@ * @example

src/bytes/index.d.ts

 export { ByteStream } from "./ByteStream.js";
-export { bytesToHex, hexToBytes } from "./base16.js";
+export type ByteArrayLike = import("./base16.js").ByteArrayLike;
+export { bytesToHex, hexToBytes, toBytes } from "./base16.js";
 export { Base32, decodeBase32, encodeBase32, isValidBase32 } from "./base32.js";
@@ -4,0 +5,0 @@ export { Base64, decodeBase64, encodeBase64, isValidBase64 } from "./base64.js";

src/bytes/index.js

 export { ByteStream } from "./ByteStream.js"
-export { bytesToHex, hexToBytes } from "./base16.js"
+export { bytesToHex, hexToBytes, toBytes } from "./base16.js"
 export { Base32, decodeBase32, encodeBase32, isValidBase32 } from "./base32.js"
 export { Base64, decodeBase64, encodeBase64, isValidBase64 } from "./base64.js"
 export { compareBytes, padBytes } from "./ops.js"
+
+/**
+ * @typedef {import("./base16.js").ByteArrayLike} ByteArrayLike
+ */

src/option/index.d.ts

@@ -10,5 +10,5 @@ /**
  * @param {Option<T>} opt
- * @returns {opt is null}
+ * @returns {opt is (null | undefined)}
  */
-export function isNone<T>(opt: Option<T>): opt is null;
+export function isNone<T>(opt: Option<T>): opt is null | undefined;
 /**
@@ -15,0 +15,0 @@ * @template T

src/option/index.js

@@ -23,3 +23,3 @@ /**
  * @param {Option<T>} opt
- * @returns {opt is null}
+ * @returns {opt is (null | undefined)}
  */
@@ -26,0 +26,0 @@ export function isNone(opt) {

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

66955

increased by1.88%

Lines of code

2047

increased by1.74%

No dependency changes