fast-equals 4.0.0-beta.0 → 4.0.0

package/src/index.ts

@@ -22,6 +22,7 @@ export type {
   EqualityComparatorCreator,
   InternalEqualityComparator,
   NativeEqualityComparator,
+  TypeEqualityComparator,
 } from './utils';
 
 export type BaseCircularMeta = Pick<
@@ -105,7 +106,7 @@ export function circularShallowEqual<A, B>(a: A, b: B): boolean {
  * support for legacy environments that do not support expected features like
  * `RegExp.prototype.flags` out of the box.
  */
-export function createCustomEqual<Meta>(
+export function createCustomEqual<Meta = undefined>(
   getComparatorOptions: GetComparatorOptions<Meta>,
 ): EqualityComparator<Meta> {
   return createComparator<Meta>(
@@ -123,13 +124,16 @@ export function createCustomEqual<Meta>(
  * support for legacy environments that do not support expected features like
  * `WeakMap` out of the box.
  */
-export function createCustomCircularEqual<Meta extends BaseCircularMeta>(
-  getComparatorOptions: GetComparatorOptions<Meta>,
-): EqualityComparator<Meta> {
-  return createComparator<Meta>(
+export function createCustomCircularEqual<
+  Meta extends BaseCircularMeta = WeakMap<any, any>,
+>(getComparatorOptions: GetComparatorOptions<Meta>): EqualityComparator<Meta> {
+  const comparator = createComparator<Meta>(
     merge(
       DEFAULT_CIRCULAR_CONFIG,
       getComparatorOptions(DEFAULT_CIRCULAR_CONFIG as any),
     ),
   );
+
+  return ((a: any, b: any, meta: any = new WeakMap()) =>
+    comparator(a, b, meta)) as EqualityComparator<Meta>;
 }

package/src/maps.ts

@@ -8,7 +8,7 @@ import type { InternalEqualityComparator } from './utils';
 export function areMapsEqual(
   a: Map<any, any>,
   b: Map<any, any>,
-  isEqual: InternalEqualityComparator,
+  isEqual: InternalEqualityComparator<any>,
   meta: any,
 ): boolean {
   let isValueEqual = a.size === b.size;

package/src/objects.ts

@@ -15,7 +15,7 @@ const { hasOwnProperty } = Object.prototype;
 export function areObjectsEqual(
   a: Dictionary<any>,
   b: Dictionary<any>,
-  isEqual: InternalEqualityComparator,
+  isEqual: InternalEqualityComparator<any>,
   meta: any,
 ): boolean {
   const keysA = Object.keys(a);

package/src/sets.ts

@@ -8,7 +8,7 @@ import type { InternalEqualityComparator } from './utils';
 export function areSetsEqual(
   a: Set<any>,
   b: Set<any>,
-  isEqual: InternalEqualityComparator,
+  isEqual: InternalEqualityComparator<any>,
   meta: any,
 ): boolean {
   let isValueEqual = a.size === b.size;

package/src/utils.ts

@@ -1,29 +1,27 @@
-export type InternalEqualityComparator = (
+export type InternalEqualityComparator<Meta> = (
   a: any,
   b: any,
   indexOrKeyA: any,
   indexOrKeyB: any,
   parentA: any,
   parentB: any,
-  meta: any,
+  meta: Meta,
 ) => boolean;
 
-export type EqualityComparator<Meta> = <A, B>(
-  a: A,
-  b: B,
-  meta?: Meta,
-) => boolean;
+export type EqualityComparator<Meta> = Meta extends undefined
+  ? <A, B>(a: A, b: B, meta?: Meta) => boolean
+  : <A, B>(a: A, b: B, meta: Meta) => boolean;
 
 export type EqualityComparatorCreator<Meta> = (
   fn: EqualityComparator<Meta>,
-) => InternalEqualityComparator;
+) => InternalEqualityComparator<Meta>;
 
 export type NativeEqualityComparator = <A, B>(a: A, b: B) => boolean;
 
 export type TypeEqualityComparator<Type, Meta> = (
   a: Type,
   b: Type,
-  isEqual: InternalEqualityComparator,
+  isEqual: InternalEqualityComparator<Meta>,
   meta: Meta,
 ) => boolean;
 
@@ -33,7 +31,7 @@ export type TypeEqualityComparator<Type, Meta> = (
  */
 export function createDefaultIsNestedEqual<Meta>(
   comparator: EqualityComparator<Meta>,
-): InternalEqualityComparator {
+): InternalEqualityComparator<Meta> {
   return function isEqual<A, B>(
     a: A,
     b: B,
@@ -58,7 +56,7 @@ export function createIsCircular<
   return function isCircular(
     a: any,
     b: any,
-    isEqual: InternalEqualityComparator,
+    isEqual: InternalEqualityComparator<WeakMap<any, any>>,
     cache: WeakMap<any, any>,
   ) {
     if (!a || !b || typeof a !== 'object' || typeof b !== 'object') {