Merge pull request #10 from sxwei123/develop

Add more test cases and update readme

Author: sxwei123

README.md

@@ -30,18 +30,10 @@ yarn add quick-stable-stringify
 
 ## Examples
 
-Node.JS with CommonJS:
-
 ```js
+// Node.JS with CommonJS
 const stringify = require("quick-stable-stringify");
-
-const obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 };
-console.log(stringify(obj));
-```
-
-Typescript or modern Javascript environment:
-
-```ts
+// Typescript or modern Javascript environment
 import stringify from "quick-stable-stringify";
 
 const obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 };
@@ -69,11 +61,11 @@ type ComparatorFunction = (a: KeyValue, b: KeyValue) => number;
 For example, to sort by the object keys in reverse order:
 
 ```js
-var stringify = require("quick-stable-stringify");
+const stringify = require("quick-stable-stringify");
 
-var obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 };
-var s = stringify(obj, function (a, b) {
-  return a.key < b.key ? 1 : -1;
+const obj = { c: 8, b: [{ z: 6, y: 5, x: 4 }, 7], a: 3 };
+const s = stringify(obj, function (a, b) {
+  return a.key < b.key ? 1 : a.key === b.key ? 0 : -1;
 });
 console.log(s);
 ```
@@ -87,11 +79,11 @@ which results in the output string:
 To sort by the object values in reverse order:
 
 ```js
-var stringify = require("quick-stable-stringify");
+const stringify = require("quick-stable-stringify");
 
-var obj = { d: 6, c: 5, b: [{ z: 3, y: 2, x: 1 }, 9], a: 10 };
-var s = stringify(obj, function (a, b) {
-  return a.value < b.value ? 1 : -1;
+const obj = { d: 6, c: 5, b: [{ z: 3, y: 2, x: 1 }, 9], a: 10 };
+const s = stringify(obj, function (a, b) {
+  return a.value < b.value ? 1 : a.value === b.value ? 0 : -1;
 });
 console.log(s);
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "quick-stable-stringify",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "Deterministic `JSON.stringify()` - a faster version of Evgeny's fast-json-stable-strigify. Built with Typescript and modern Javascript.",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",

test/str.spec.ts test/object.spec.tstest/str.spec.ts renamed to test/object.spec.ts

@@ -1,5 +1,9 @@
 import stringify from "../src";
 
+test("empty object", () => {
+  expect(stringify({})).toEqual("{}");
+});
+
 test("simple object", () => {
   const obj = { c: 6, b: [4, 5], a: 3, z: null };
   expect(stringify(obj)).toEqual('{"a":3,"b":[4,5],"c":6,"z":null}');
@@ -30,7 +34,38 @@ test("object with empty string", () => {
   expect(stringify(obj)).toEqual('{"a":3,"z":""}');
 });
 
+test("object with Symbol", () => {
+  const obj = { a: 12, z: Symbol("") };
+  expect(stringify(obj)).toEqual('{"a":12}');
+});
+
+test("non-enumerable properties", () => {
+  const obj = Object.create(null, {
+    x: { value: "x", enumerable: false },
+    y: { value: "y", enumerable: true },
+  });
+  expect(stringify(obj)).toEqual('{"y":"y"}');
+});
+
 test("array with empty string", () => {
   const obj = [4, "", 6];
   expect(stringify(obj)).toEqual('[4,"",6]');
 });
+
+test("simple function", () => {
+  const obj = () => {
+    // empty
+  };
+  expect(stringify(obj)).toEqual(undefined);
+});
+
+test("standard data structures", () => {
+  expect(
+    stringify([
+      new Set([1]),
+      new Map([[1, 2]]),
+      new WeakSet([{ a: 1 }]),
+      new WeakMap([[{ a: 1 }, 2]]),
+    ])
+  ).toEqual("[{},{},{},{}]");
+});

test/primitive.spec.ts

@@ -0,0 +1,29 @@
+import stringify from "../src";
+
+test("undefined", () => {
+  expect(stringify(undefined)).toEqual(undefined);
+});
+
+test("true", () => {
+  expect(stringify(true)).toEqual("true");
+});
+
+test("string", () => {
+  expect(stringify("foo")).toEqual(`"foo"`);
+});
+
+test("symbol", () => {
+  expect(stringify(Symbol(""))).toEqual(undefined);
+});
+
+test("NaN", () => {
+  expect(stringify(NaN)).toEqual("null");
+});
+
+test("Infinity", () => {
+  expect(stringify(Infinity)).toEqual("null");
+});
+
+test("null", () => {
+  expect(stringify(null)).toEqual("null");
+});