feat: add isEqual

README.md

@@ -59,6 +59,19 @@ import { objectHash } from 'ohash'
 console.log(objectHash({ foo: 'bar'}))
 ```
 
+### `isEqual(obj1, obj2, options?)`
+
+Compare two objects using reference equality and stable object hashing.
+
+Usage:
+
+```js
+import { isEqual } from 'ohash'
+
+// true
+console.log(isEqual({ a: 1, b: 2 }, { b: 2, a: 1 }))
+```
+
 ### `murmurHash(str)`
 
 Converts input string (of any length) into a 32-bit positive integer using [MurmurHash3]((https://en.wikipedia.org/wiki/MurmurHash)).

src/index.ts

@@ -2,3 +2,4 @@ export { objectHash } from './object-hash'
 export { hash } from './hash'
 export { murmurHash } from './crypto/murmur'
 export { sha256 } from './crypto/sha256'
+export { isEqual } from './utils'

src/utils.ts

@@ -0,0 +1,18 @@
+import { objectHash, HashOptions } from './object-hash'
+/**
+ * Compare two objects using reference equality and stable deep hashing.
+ * @param {any} object1 First object
+ * @param {any} object2 Second object
+ * @param {HashOptions} hash options
+ * @return {boolean} true if equal and false if not
+ * @api public
+ */
+export function isEqual (object1: any, object2: any, hashOptions: HashOptions = {}): boolean {
+  if (object1 === object2) {
+    return true
+  }
+  if (objectHash(object1, hashOptions) === objectHash(object2, hashOptions)) {
+    return true
+  }
+  return false
+}

test/index.test.ts

@@ -1,5 +1,5 @@
-import { expect, it } from 'vitest'
-import { murmurHash, objectHash, hash, sha256 } from '../src'
+import { describe, expect, it } from 'vitest'
+import { murmurHash, objectHash, hash, sha256, isEqual } from '../src'
 import { sha256base64 } from '../src/crypto/sha256'
 
 it('murmurHash', () => {
@@ -23,3 +23,19 @@ it('objectHash', () => {
 it('hash', () => {
   expect(hash({ foo: 'bar' })).toMatchInlineSnapshot('"dZbtA7f0lK"')
 })
+
+describe('isEqual', () => {
+  const cases = [
+    [{ foo: 'bar' }, { foo: 'bar' }, true],
+    [{ foo: 'bar' }, { foo: 'baz' }, false],
+    [{ a: 1, b: 2 }, { b: 2, a: 1 }, true],
+    [123, 123, true],
+    [123, 456, false],
+    [[1, 2], [2, 1], false]
+  ]
+  for (const [obj1, obj2, equals] of cases) {
+    it(`${JSON.stringify(obj1)} ${equals ? 'equals' : 'not equals'} to ${JSON.stringify(obj2)}`, () => {
+      expect(isEqual(obj1, obj2)).toBe(equals)
+    })
+  }
+})