@thi.ng/bitstream 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-08-19T13:45:57Z
+- **Last updated**: 2024-08-23T16:18:16Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.
@@ -9,6 +9,13 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+## [2.4.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/bitstream@2.4.0) (2024-08-23)
+
+#### 🚀 Features
+
+- add read16/24/32() fns ([edf19e7](https://github.com/thi-ng/umbrella/commit/edf19e7))
+  - add tests
+
 ## [2.3.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/bitstream@2.3.0) (2024-08-19)
 
 #### 🚀 Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/bitstream",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "ES6 iterator based read/write bit streams with support for variable word widths",
   "type": "module",
   "module": "./index.js",
@@ -81,5 +81,5 @@
       "rle-pack"
     ]
   },
-  "gitHead": "bfbc227cf5ca2d3c2984b3d4713eebd6225cbd54\n"
+  "gitHead": "0d01681c64f5459647ab06f197f70dc90fb64cc9\n"
 }

package/simple.d.ts

@@ -23,4 +23,22 @@ export declare const bitWriter: (capacity?: number) => {
  * @param buf
  */
 export declare const bitReader: (buf: Uint8Array | number[]) => (n?: number) => number;
+/**
+ * Wrapper for {@link bitReader} to read a 16bit word (big endian)
+ *
+ * @param read
+ */
+export declare const read16: (read: (n: number) => number) => number;
+/**
+ * Wrapper for {@link bitReader} to read a 24bit word (big endian)
+ *
+ * @param read
+ */
+export declare const read24: (read: (n: number) => number) => number;
+/**
+ * Wrapper for {@link bitReader} to read a 32bit word (big endian, unsigned)
+ *
+ * @param read
+ */
+export declare const read32: (read: (n: number) => number) => number;
 //# sourceMappingURL=simple.d.ts.map

package/simple.js

@@ -54,7 +54,13 @@ const bitReader = (buf) => {
     return out;
   };
 };
+const read16 = (read) => read(8) << 8 | read(8);
+const read24 = (read) => read16(read) << 8 | read(8);
+const read32 = (read) => (read16(read) << 16 | read16(read)) >>> 0;
 export {
   bitReader,
-  bitWriter
+  bitWriter,
+  read16,
+  read24,
+  read32
 };