[Implement] Buffer.compare

assembly/buffer/index.ts

@@ -23,6 +23,16 @@ export class Buffer extends Uint8Array {
     return result;
   }
 
+  public static compare(a: Buffer, b: Buffer): i32 {
+    let compareLength = min<i32>(a.length, b.length);
+    let result = memory.compare(a.dataStart, b.dataStart, compareLength);
+    if (result == 0) {
+      return a.length - b.length;
+    } else {
+      return result;
+    }
+  };
+
   public static isBuffer<T>(value: T): bool {
     return value instanceof Buffer;
   }

assembly/node.d.ts

@@ -3,6 +3,8 @@ declare class Buffer extends Uint8Array {
   static alloc(size: i32): Buffer;
   /** This method allocates a new Buffer of indicated size. This is unsafe because the data is not zeroed. */
   static allocUnsafe(size: i32): Buffer;
+  /** This method is used for sorting Buffer objects. */
+  static compare(a: Buffer, b: Buffer): i32;
   /** This method asserts a value is a Buffer object via `value instanceof Buffer`. */
   static isBuffer<T>(value: T): bool;
   /** Reads an unsigned integer at the designated offset. */

tests/buffer.spec.ts

@@ -1,3 +1,10 @@
+function createFrom<T>(values: valueof<T>[]): T {
+  let result = instantiate<T>(values.length);
+  // @ts-ignore
+  for (let i = 0; i < values.length; i++) result[i] = values[i];
+  return result;
+}
+
 /**
  * This is the buffer test suite. For each prototype function, put a single test
  * function call here.
@@ -43,6 +50,18 @@ describe("buffer", () => {
     // TODO: expectFn(() => { Buffer.allocUnsafe(BLOCK_MAXSIZE + 1); }).toThrow();
   });
 
+  test("#compare", () => {
+    let a = createFrom<Buffer>([0x05, 0x06, 0x07, 0x08]);
+    let b = createFrom<Buffer>([0x01, 0x02, 0x03]);
+    let c = createFrom<Buffer>([0x05, 0x06, 0x07]);
+    let d = createFrom<Buffer>([0x04, 0x05, 0x06]);
+
+    let actual: Buffer[] = [a, b, c, d];
+    actual.sort(Buffer.compare);
+    let expected: Buffer[] = [b, d, c, a];
+    expect<Buffer[]>(actual).toStrictEqual(expected);
+  });
+
   test("#isBuffer", () => {
     let a = "";
     let b = new Uint8Array(0);