ordered-binary 1.2.3 → 1.2.4

package/README.md

@@ -32,3 +32,8 @@ The main module exports these functions:
 `toBufferKey(jsPrimitive)` - This accepts a string, number, or boolean as the argument, and returns a `Buffer`.
 
 `fromBufferKey(bufferKey, multiple)` - This accepts a Buffer and returns a JavaScript primitive value. This can also parse buffers that hold multiple values delimited by a byte `30`, by setting the second argument to true (in which case it will return an array).
+
+And these constants:
+
+`MINIMUM_KEY` - The minimum key supported (`null`, which is represented as single zero byte)
+`MAXIMUM_KEY` - A maximum key larger than any supported primitive (single 0xff byte)

package/index.d.ts

@@ -0,0 +1,19 @@
+type Key = Key[] | string | symbol | number | boolean | Uint8Array;
+/** Writes a key (a primitive value) to the target buffer, starting at the given position */
+export function writeKey(key: Key, target: Uint8Array, position: number, inSequence?: boolean): number;
+/** Reads a key from the provided buffer, from the given range */
+export function readKey(buffer: Uint8Array, start: number, end: number, inSequence?: boolean): Key;
+/** Compares two keys, returning -1 if `a` comes before `b` in the ordered binary representation of the keys, or 1 if `a` comes after `b`, or 0 if they are equivalent */
+export function compareKeys(a: Key, b: Key): number;
+/** The minimum key, with the "first" binary representation (one byte of zero) */
+export const MINIMUM_KEY: null
+/** A maximum key, with a binary representation after all other JS primitives (one byte of 0xff) */
+export const MAXIMUM_KEY: Uint8Array
+/** Enables null termination, ensuring that writing keys to buffers will end with a padding of zeros at the end to complete the following 32-bit word */
+export function enableNullTermination(): void;
+/** An object that holds the functions for encapsulation as a single encoder */
+export const encoder: {
+	writeKey: typeof writeKey,
+	readKey: typeof readKey,
+	enableNullTermination: typeof enableNullTermination,
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "ordered-binary",
   "author": "Kris Zyp",
-  "version": "1.2.3",
+  "version": "1.2.4",
   "description": "Conversion of JavaScript primitives to and from Buffer with binary order matching natural primitive order",
   "license": "MIT",
   "repository": {
@@ -31,7 +31,7 @@
   "devDependencies": {
     "@types/node": "latest",
     "chai": "^4",
-    "mocha": "^9.1.3",
+    "mocha": "^9.2.0",
     "rollup": "^2.61.1"
   }
 }