@quentinadam/hex 0.1.2

package/README.md

@@ -0,0 +1,22 @@
+# @quentinadam/hex
+
+[![JSR][jsr-image]][jsr-url] [![NPM][npm-image]][npm-url] [![CI][ci-image]][ci-url]
+
+A simple library to encode and decode hex strings.
+
+## Usage
+
+```ts
+import * as hex from '@quentinadam/hex';
+
+hex.decode('000102'); // returns Uint8Array([0, 1, 2])
+
+hex.encode(new Uint8Array([0, 1, 2])); // returns '000102'
+```
+
+[ci-image]: https://img.shields.io/github/actions/workflow/status/quentinadam/deno-hex/ci.yml?branch=main&logo=github&style=flat-square
+[ci-url]: https://github.com/quentinadam/deno-hex/actions/workflows/ci.yml
+[npm-image]: https://img.shields.io/npm/v/@quentinadam/hex.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@quentinadam/hex
+[jsr-image]: https://jsr.io/badges/@quentinadam/hex?style=flat-square
+[jsr-url]: https://jsr.io/@quentinadam/hex

package/dist/hex.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Decodes a hex encoded string into a Uint8Array buffer.
+ *
+ * @param string The hex encoded string.
+ * @returns The decoded buffer.
+ */
+export declare function decode(hex: string): Uint8Array;
+/**
+ * Encodes a Uint8Array buffer into a hex string.
+ *
+ * @param buffer The buffer to encode.
+ * @returns The hex encoded string.
+ */
+export declare function encode(buffer: Uint8Array): string;

package/dist/hex.js

@@ -0,0 +1,25 @@
+import assert from '@quentinadam/assert';
+/**
+ * Decodes a hex encoded string into a Uint8Array buffer.
+ *
+ * @param string The hex encoded string.
+ * @returns The decoded buffer.
+ */
+export function decode(hex) {
+    assert(/^[0-9a-fA-F]*$/.test(hex), 'Hex string must only contain hex characters');
+    assert(hex.length % 2 === 0, 'Hex string length must be even');
+    const buffer = new Uint8Array(hex.length / 2);
+    for (let i = 0; i < hex.length; i += 2) {
+        buffer[i / 2] = parseInt(hex.slice(i, i + 2), 16);
+    }
+    return buffer;
+}
+/**
+ * Encodes a Uint8Array buffer into a hex string.
+ *
+ * @param buffer The buffer to encode.
+ * @returns The hex encoded string.
+ */
+export function encode(buffer) {
+    return Array.from(buffer).map((byte) => byte.toString(16).padStart(2, '0')).join('');
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@quentinadam/hex",
+  "version": "0.1.2",
+  "description": "A simple library to encode and decode hex strings",
+  "license": "MIT",
+  "author": "Quentin Adam",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/quentinadam/deno-hex.git"
+  },
+  "type": "module",
+  "exports": "./dist/hex.js",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "dependencies": {
+    "@quentinadam/assert": "^0.1.10"
+  }
+}