update readme

gfx · gfx · commit 788f81fc8420 · 2019-05-06T22:09:59.000+09:00
diff --git a/README.md b/README.md
@@ -39,6 +39,20 @@ This library is publised as [@msgpack/msgpack](https://www.npmjs.com/package/@ms
 npm install @msgpack/msgpack
 ```
 
+## Encode and Decode
+
+### `encode(data: unknown, options?): Uint8Array`
+
+It encodes `data` and returns a byte array as `Uint8Array`.
+
+### `decode(buffer: ArrayLike<number> | Uint8Array, options?): unknown`
+
+It decodes `buffer` in a byte buffer and returns decoded data as `uknown`.
+
+### `decodeAsync(stream: AsyncIterable<ArrayLike<number> | Uint8Array>, options?): Promise<unknown>`
+
+It decodes `stream` in an async iterable of byte arrays and returns decoded data as `uknown` wrapped in `Promise`. This function works asyncronously.
+
 ## Extension Types
 
 To handle [MessagePack Extension Types](https://github.com/msgpack/msgpack/blob/master/spec.md#extension-types), this library provides `ExtensionCodec` class.
diff --git a/benchmark/sync-vs-async.ts b/benchmark/sync-vs-async.ts
@@ -0,0 +1,42 @@
+#!ts-node
+/* eslint-disable no-console */
+
+import { encode, decode, decodeAsync } from "../src";
+import { writeFileSync, unlinkSync, readFileSync, createReadStream } from "fs";
+import { deepStrictEqual } from "assert";
+
+(async () => {
+  const data = [];
+  for (let i = 0; i < 1000; i++) {
+    const id = i + 1;
+    data.push({
+      id,
+      score: Math.round(Math.random() * Number.MAX_SAFE_INTEGER),
+      title: `Hello, world! #${id}`,
+      content: `blah blah blah `.repeat(20).trim(),
+      createdAt: new Date(),
+    });
+  }
+  const encoded = encode(data);
+  const file = "benchmark/tmp.msgpack";
+  writeFileSync(file, encoded);
+  process.on("exit", () => unlinkSync(file));
+  console.log(`encoded size ${Math.round(encoded.byteLength / 1024)}KiB`);
+
+  deepStrictEqual(decode(readFileSync(file)), data);
+  deepStrictEqual(await decodeAsync(createReadStream(file)), data);
+
+  // sync
+  console.time("readFileSync |> decode");
+  for (let i = 0; i < 100; i++) {
+    decode(readFileSync(file));
+  }
+  console.timeEnd("readFileSync |> decode");
+
+  // async
+  console.time("creteReadStream |> decodeAsync");
+  for (let i = 0; i < 100; i++) {
+    await decodeAsync(createReadStream(file));
+  }
+  console.timeEnd("creteReadStream |> decodeAsync");
+})();
