Merge pull request #8 from msgpack/encode_returns_uint8array

Make encode() return Uint8Array

Author: gfx

src/encode.ts

@@ -1,5 +1,6 @@
 import { ExtensionCodec, ExtensionCodecType } from "./ExtensionCodec";
 import { Encoder } from "./Encoder";
+import { WritableBuffer } from "./utils/WritableBuffer";
 
 export type EncodeOptions = Readonly<{
   maxDepth: number;
@@ -8,14 +9,14 @@ export type EncodeOptions = Readonly<{
 
 export const DEFAULT_MAX_DEPTH = 100;
 
-export function encode(value: unknown, options: Partial<EncodeOptions> = {}): Array<number> {
-  const output: Array<number> = [];
+export function encode(value: unknown, options: Partial<EncodeOptions> = {}): Uint8Array {
+  const output = new WritableBuffer();
 
   const context = new Encoder(
     options.maxDepth || DEFAULT_MAX_DEPTH,
     options.extensionCodec || ExtensionCodec.defaultCodec,
   );
   context.encode(output, value, 1);
 
-  return output;
+  return output.toUint8Array();
 }

src/utils/WritableBuffer.ts

@@ -0,0 +1,35 @@
+import { Writable } from "../Writable";
+
+// Experimental `push(...bytes)`-able buffer
+// Unfortunately, it is always slower than Array<number>.
+
+export class WritableBuffer implements Writable<number> {
+  private length = 0;
+  private buffer = new Uint8Array(128);
+
+  push(...bytes: ReadonlyArray<number>): void {
+    const offset = this.length;
+    const bytesLen = bytes.length;
+    const newLength = offset + bytesLen;
+
+    if (this.buffer.length < newLength) {
+      this.grow(newLength);
+    }
+
+    const buffer = this.buffer;
+    for (let i = 0; i < bytesLen; i++) {
+      buffer[offset + i] = bytes[i];
+    }
+    this.length = newLength;
+  }
+
+  grow(newLength: number) {
+    const newBuffer = new Uint8Array(newLength * 2);
+    newBuffer.set(this.buffer);
+    this.buffer = newBuffer;
+  }
+
+  toUint8Array(): Uint8Array {
+    return this.buffer.subarray(0, this.length);
+  }
+}

tsconfig.json

@@ -1,7 +1,7 @@
 {
   "compilerOptions": {
     /* Basic Options */
-    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "target": "es2019",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "lib": ["es2019", "dom"],                             /* Specify library files to be included in the compilation. */
     // "allowJs": true,                       /* Allow javascript files to be compiled. */

tsconfig.production.json

@@ -1,6 +1,7 @@
 {
   "extends": "./tsconfig.json",
   "compilerOptions": {
+    "target": "es5",
     "outDir": "./dist",
     "declaration": true,
     "noEmitOnError": true,