fast-equals 5.4.0 → 5.4.1

package/index.d.ts

@@ -3,178 +3,159 @@
  * reference checks.
  */
 interface Cache<Key extends object, Value> {
-  delete(key: Key): boolean;
-  get(key: Key): Value | undefined;
-  set(key: Key, value: any): any;
+    delete(key: Key): boolean;
+    get(key: Key): Value | undefined;
+    set(key: Key, value: any): any;
 }
 interface State<Meta> {
-  /**
-   * Cache used to identify circular references
-   */
-  readonly cache: Cache<any, any> | undefined;
-  /**
-   * Method used to determine equality of nested value.
-   */
-  readonly equals: InternalEqualityComparator<Meta>;
-  /**
-   * Additional value that can be used for comparisons.
-   */
-  meta: Meta;
-  /**
-   * Whether the equality comparison is strict, meaning it matches
-   * all properties (including symbols and non-enumerable properties)
-   * with equal shape of descriptors.
-   */
-  readonly strict: boolean;
+    /**
+     * Cache used to identify circular references
+     */
+    readonly cache: Cache<any, any> | undefined;
+    /**
+     * Method used to determine equality of nested value.
+     */
+    readonly equals: InternalEqualityComparator<Meta>;
+    /**
+     * Additional value that can be used for comparisons.
+     */
+    meta: Meta;
+    /**
+     * Whether the equality comparison is strict, meaning it matches
+     * all properties (including symbols and non-enumerable properties)
+     * with equal shape of descriptors.
+     */
+    readonly strict: boolean;
 }
 interface CircularState<Meta> extends State<Meta> {
-  readonly cache: Cache<any, any>;
+    readonly cache: Cache<any, any>;
 }
 interface DefaultState<Meta> extends State<Meta> {
-  readonly cache: undefined;
+    readonly cache: undefined;
 }
 interface Dictionary<Value = any> {
-  [key: string | symbol]: Value;
-  $$typeof?: any;
+    [key: string | symbol]: Value;
+    $$typeof?: any;
 }
 interface ComparatorConfig<Meta> {
-  /**
-   * Whether the array buffers passed are equal in value. In strict mode, this includes
-   * additional properties added to the array.
-   */
-  areArrayBuffersEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the arrays passed are equal in value. In strict mode, this includes
-   * additional properties added to the array.
-   */
-  areArraysEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the data views passed are equal in value.
-   */
-  areDataViewsEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the dates passed are equal in value.
-   */
-  areDatesEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the errors passed are equal in value.
-   */
-  areErrorsEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the functions passed are equal in value.
-   */
-  areFunctionsEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the maps passed are equal in value. In strict mode, this includes
-   * additional properties added to the map.
-   */
-  areMapsEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the numbers passed are equal in value.
-   */
-  areNumbersEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the objects passed are equal in value. In strict mode, this includes
-   * non-enumerable properties added to the map, as well as symbol properties.
-   */
-  areObjectsEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the primitive wrappers passed are equal in value.
-   */
-  arePrimitiveWrappersEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the regexps passed are equal in value.
-   */
-  areRegExpsEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the sets passed are equal in value. In strict mode, this includes
-   * additional properties added to the set.
-   */
-  areSetsEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the typed arrays passed are equal in value. In strict mode, this includes
-   * additional properties added to the typed array.
-   */
-  areTypedArraysEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether the URLs passed are equal in value.
-   */
-  areUrlsEqual: TypeEqualityComparator<any, Meta>;
-  /**
-   * Whether two values with unknown `@@toStringTag` are equal in value. This comparator is
-   * called when no other comparator applies.
-   *
-   * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag
-   */
-  unknownTagComparators: Record<string, TypeEqualityComparator<any, Meta>> | undefined;
+    /**
+     * Whether the array buffers passed are equal in value. In strict mode, this includes
+     * additional properties added to the array.
+     */
+    areArrayBuffersEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the arrays passed are equal in value. In strict mode, this includes
+     * additional properties added to the array.
+     */
+    areArraysEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the data views passed are equal in value.
+     */
+    areDataViewsEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the dates passed are equal in value.
+     */
+    areDatesEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the errors passed are equal in value.
+     */
+    areErrorsEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the functions passed are equal in value.
+     */
+    areFunctionsEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the maps passed are equal in value. In strict mode, this includes
+     * additional properties added to the map.
+     */
+    areMapsEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the numbers passed are equal in value.
+     */
+    areNumbersEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the objects passed are equal in value. In strict mode, this includes
+     * non-enumerable properties added to the map, as well as symbol properties.
+     */
+    areObjectsEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the primitive wrappers passed are equal in value.
+     */
+    arePrimitiveWrappersEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the regexps passed are equal in value.
+     */
+    areRegExpsEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the sets passed are equal in value. In strict mode, this includes
+     * additional properties added to the set.
+     */
+    areSetsEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the typed arrays passed are equal in value. In strict mode, this includes
+     * additional properties added to the typed array.
+     */
+    areTypedArraysEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether the URLs passed are equal in value.
+     */
+    areUrlsEqual: TypeEqualityComparator<any, Meta>;
+    /**
+     * Whether two values with unknown `@@toStringTag` are equal in value. This comparator is
+     * called when no other comparator applies.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag
+     */
+    unknownTagComparators: Record<string, TypeEqualityComparator<any, Meta>> | undefined;
 }
 type CreateCustomComparatorConfig<Meta> = (config: ComparatorConfig<Meta>) => Partial<ComparatorConfig<Meta>>;
 type CreateState<Meta> = () => {
-  cache?: Cache<any, any> | undefined;
-  meta?: Meta;
+    cache?: Cache<any, any> | undefined;
+    meta?: Meta;
 };
 type EqualityComparator<Meta> = <A, B>(a: A, b: B, state: State<Meta>) => boolean;
 type AnyEqualityComparator<Meta> = (a: any, b: any, state: State<Meta>) => boolean;
 type EqualityComparatorCreator<Meta> = (fn: EqualityComparator<Meta>) => InternalEqualityComparator<Meta>;
-type InternalEqualityComparator<Meta> = (
-  a: any,
-  b: any,
-  indexOrKeyA: any,
-  indexOrKeyB: any,
-  parentA: any,
-  parentB: any,
-  state: State<Meta>,
-) => boolean;
+type InternalEqualityComparator<Meta> = (a: any, b: any, indexOrKeyA: any, indexOrKeyB: any, parentA: any, parentB: any, state: State<Meta>) => boolean;
 type PrimitiveWrapper = Boolean | Number | String;
 /**
  * Type which encompasses possible instances of TypedArray
  * classes.
  */
-type TypedArray =
-  | BigInt64Array
-  | BigUint64Array
-  | Float32Array
-  | Float64Array
-  | Int8Array
-  | Int16Array
-  | Int32Array
-  | Uint16Array
-  | Uint32Array
-  | Uint8Array
-  | Uint8ClampedArray;
+type TypedArray = BigInt64Array | BigUint64Array | Float32Array | Float64Array | Int8Array | Int16Array | Int32Array | Uint16Array | Uint32Array | Uint8Array | Uint8ClampedArray;
 type TypeEqualityComparator<Type, Meta = undefined> = (a: Type, b: Type, state: State<Meta>) => boolean;
 interface CustomEqualCreatorOptions<Meta> {
-  /**
-   * Whether circular references should be supported. It causes the
-   * comparison to be slower, but for objects that have circular references
-   * it is required to avoid stack overflows.
-   */
-  circular?: boolean;
-  /**
-   * Create a custom configuration of type-specific equality comparators.
-   * This receives the default configuration, which allows either replacement
-   * or supersetting of the default methods.
-   */
-  createCustomConfig?: CreateCustomComparatorConfig<Meta>;
-  /**
-   * Create a custom internal comparator, which is used as an override to the
-   * default entry point for nested value equality comparisons. This is often
-   * used for doing custom logic for specific types (such as handling a specific
-   * class instance differently than other objects) or to incorporate `meta` in
-   * the comparison. See the recipes for examples.
-   */
-  createInternalComparator?: (compare: EqualityComparator<Meta>) => InternalEqualityComparator<Meta>;
-  /**
-   * Create a custom `state` object passed between the methods. This allows for
-   * custom `cache` and/or `meta` values to be used.
-   */
-  createState?: CreateState<Meta>;
-  /**
-   * Whether the equality comparison is strict, meaning it matches
-   * all properties (including symbols and non-enumerable properties)
-   * with equal shape of descriptors.
-   */
-  strict?: boolean;
+    /**
+     * Whether circular references should be supported. It causes the
+     * comparison to be slower, but for objects that have circular references
+     * it is required to avoid stack overflows.
+     */
+    circular?: boolean;
+    /**
+     * Create a custom configuration of type-specific equality comparators.
+     * This receives the default configuration, which allows either replacement
+     * or supersetting of the default methods.
+     */
+    createCustomConfig?: CreateCustomComparatorConfig<Meta>;
+    /**
+     * Create a custom internal comparator, which is used as an override to the
+     * default entry point for nested value equality comparisons. This is often
+     * used for doing custom logic for specific types (such as handling a specific
+     * class instance differently than other objects) or to incorporate `meta` in
+     * the comparison. See the recipes for examples.
+     */
+    createInternalComparator?: (compare: EqualityComparator<Meta>) => InternalEqualityComparator<Meta>;
+    /**
+     * Create a custom `state` object passed between the methods. This allows for
+     * custom `cache` and/or `meta` values to be used.
+     */
+    createState?: CreateState<Meta>;
+    /**
+     * Whether the equality comparison is strict, meaning it matches
+     * all properties (including symbols and non-enumerable properties)
+     * with equal shape of descriptors.
+     */
+    strict?: boolean;
 }
 
 /**
@@ -224,37 +205,7 @@ declare const strictCircularShallowEqual: <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.
  */
-declare function createCustomEqual<Meta = undefined>(
-  options?: CustomEqualCreatorOptions<Meta>,
-): <A, B>(a: A, b: B) => boolean;
+declare function createCustomEqual<Meta = undefined>(options?: CustomEqualCreatorOptions<Meta>): <A, B>(a: A, b: B) => boolean;
 
-export {
-  circularDeepEqual,
-  circularShallowEqual,
-  createCustomEqual,
-  deepEqual,
-  sameValueZeroEqual,
-  shallowEqual,
-  strictCircularDeepEqual,
-  strictCircularShallowEqual,
-  strictDeepEqual,
-  strictShallowEqual,
-};
-export type {
-  AnyEqualityComparator,
-  Cache,
-  CircularState,
-  ComparatorConfig,
-  CreateCustomComparatorConfig,
-  CreateState,
-  CustomEqualCreatorOptions,
-  DefaultState,
-  Dictionary,
-  EqualityComparator,
-  EqualityComparatorCreator,
-  InternalEqualityComparator,
-  PrimitiveWrapper,
-  State,
-  TypeEqualityComparator,
-  TypedArray,
-};
+export { circularDeepEqual, circularShallowEqual, createCustomEqual, deepEqual, sameValueZeroEqual, shallowEqual, strictCircularDeepEqual, strictCircularShallowEqual, strictDeepEqual, strictShallowEqual };
+export type { AnyEqualityComparator, Cache, CircularState, ComparatorConfig, CreateCustomComparatorConfig, CreateState, CustomEqualCreatorOptions, DefaultState, Dictionary, EqualityComparator, EqualityComparatorCreator, InternalEqualityComparator, PrimitiveWrapper, State, TypeEqualityComparator, TypedArray };

package/package.json

@@ -1,45 +1,49 @@
 {
-  "author": "tony_quetano@planttheidea.com",
-  "browser": "dist/umd/index.js",
+  "author": {
+    "email": "tony.quetano@planttheidea.com",
+    "name": "Tony Quetano",
+    "url": "https://www.planttheidea.com/"
+  },
+  "browser": "./dist/umd/index.js",
   "bugs": {
     "url": "https://github.com/planttheidea/fast-equals/issues"
   },
   "description": "A blazing fast equality comparison, either shallow or deep",
   "devDependencies": {
-    "@planttheidea/build-tools": "^1.2.3",
-    "@types/lodash": "^4.17.21",
-    "@types/node": "^24.10.3",
+    "@planttheidea/build-tools": "^2.0.2",
+    "@types/lodash": "^4.17.24",
+    "@types/node": "^24.13.3",
     "@types/ramda": "^0.31.1",
-    "@types/react": "^19.2.7",
+    "@types/react": "^19.2.17",
     "@types/react-dom": "^19.2.3",
-    "@typescript-eslint/eslint-plugin": "^8.49.0",
-    "@typescript-eslint/parser": "^8.49.0",
-    "@vitest/coverage-v8": "^4.0.15",
+    "@typescript-eslint/eslint-plugin": "^8.63.0",
+    "@typescript-eslint/parser": "^8.63.0",
+    "@vitest/coverage-v8": "^4.1.10",
     "cli-table3": "^0.6.5",
     "decircularize": "^1.0.0",
     "deep-eql": "^5.0.2",
     "deep-equal": "^2.2.3",
     "dequal": "^2.0.3",
-    "eslint": "^9.39.2",
+    "eslint": "^9.39.4",
     "eslint-friendly-formatter": "^4.0.1",
     "eslint-plugin-import": "^2.32.0",
     "fast-deep-equal": "^3.1.3",
     "fast-glob": "^3.3.3",
-    "lodash": "^4.17.21",
+    "lodash": "^4.18.1",
     "nano-equal": "^2.0.2",
-    "prettier": "^3.7.4",
-    "react": "^19.2.3",
-    "react-dom": "^19.2.3",
+    "prettier": "^3.9.4",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
     "react-fast-compare": "^3.2.2",
-    "release-it": "^19.1.0",
-    "rollup": "^4.53.3",
+    "release-it": "^20.2.1",
+    "rollup": "^4.62.2",
     "shallow-equal-fuzzy": "^0.0.2",
-    "tinybench": "^6.0.0",
+    "tinybench": "^6.0.2",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.49.0",
-    "underscore": "^1.13.7",
-    "vite": "^7.2.7",
-    "vitest": "^4.0.15"
+    "typescript-eslint": "^8.63.0",
+    "underscore": "^1.13.8",
+    "vite": "^8.1.4",
+    "vitest": "^4.1.10"
   },
   "engines": {
     "node": ">=6.0.0"
@@ -76,16 +80,19 @@
     "equivalent"
   ],
   "license": "MIT",
-  "main": "dist/cjs/index.cjs",
-  "module": "dist/es/index.mjs",
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/es/index.mjs",
   "name": "fast-equals",
+  "publishConfig": {
+    "access": "public"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/planttheidea/fast-equals.git"
   },
   "scripts": {
     "benchmark": "npm run build && node benchmark/index.js",
-    "build": "npm run clean && npm run build:dist && npm run build:types",
+    "build": "npm run clean && npm run build:dist",
     "build:dist": "NODE_ENV=production rollup -c config/rollup.config.js",
     "build:types": "pti fix-types -l dist",
     "clean": "rm -rf dist",
@@ -109,5 +116,5 @@
   "sideEffects": false,
   "type": "module",
   "types": "./index.d.ts",
-  "version": "5.4.0"
+  "version": "5.4.1"
 }

package/dist/cjs/comparator.d.cts

@@ -1,60 +0,0 @@
-import type {
-  ComparatorConfig,
-  CreateState,
-  CustomEqualCreatorOptions,
-  EqualityComparator,
-  InternalEqualityComparator,
-} from './internalTypes.d.cts';
-interface CreateIsEqualOptions<Meta> {
-  circular: boolean;
-  comparator: EqualityComparator<Meta>;
-  createState: CreateState<Meta> | undefined;
-  equals: InternalEqualityComparator<Meta>;
-  strict: boolean;
-}
-/**
- * Create a comparator method based on the type-specific equality comparators passed.
- */
-export declare function createEqualityComparator<Meta>({
-  areArrayBuffersEqual,
-  areArraysEqual,
-  areDataViewsEqual,
-  areDatesEqual,
-  areErrorsEqual,
-  areFunctionsEqual,
-  areMapsEqual,
-  areNumbersEqual,
-  areObjectsEqual,
-  arePrimitiveWrappersEqual,
-  areRegExpsEqual,
-  areSetsEqual,
-  areTypedArraysEqual,
-  areUrlsEqual,
-  unknownTagComparators,
-}: ComparatorConfig<Meta>): EqualityComparator<Meta>;
-/**
- * Create the configuration object used for building comparators.
- */
-export declare function createEqualityComparatorConfig<Meta>({
-  circular,
-  createCustomConfig,
-  strict,
-}: CustomEqualCreatorOptions<Meta>): ComparatorConfig<Meta>;
-/**
- * Default equality comparator pass-through, used as the standard `isEqual` creator for
- * use inside the built comparator.
- */
-export declare function createInternalEqualityComparator<Meta>(
-  compare: EqualityComparator<Meta>,
-): InternalEqualityComparator<Meta>;
-/**
- * Create the `isEqual` function used by the consuming application.
- */
-export declare function createIsEqual<Meta>({
-  circular,
-  comparator,
-  createState,
-  equals,
-  strict,
-}: CreateIsEqualOptions<Meta>): <A, B>(a: A, b: B) => boolean;
-export {};

package/dist/cjs/equals.d.cts

@@ -1,62 +0,0 @@
-import type { Dictionary, PrimitiveWrapper, State, TypedArray } from './internalTypes.d.cts';
-import type { sameValueZeroEqual } from './utils.d.cts';
-/**
- * Whether the array buffers are equal in value.
- */
-export declare function areArrayBuffersEqual(a: ArrayBuffer, b: ArrayBuffer): boolean;
-/**
- * Whether the arrays are equal in value.
- */
-export declare function areArraysEqual(a: any[], b: any[], state: State<any>): boolean;
-/**
- * Whether the dataviews are equal in value.
- */
-export declare function areDataViewsEqual(a: DataView, b: DataView): boolean;
-/**
- * Whether the dates passed are equal in value.
- */
-export declare function areDatesEqual(a: Date, b: Date): boolean;
-/**
- * Whether the errors passed are equal in value.
- */
-export declare function areErrorsEqual(a: Error, b: Error): boolean;
-/**
- * Whether the functions passed are equal in value.
- */
-export declare function areFunctionsEqual(a: (...args: any[]) => any, b: (...args: any[]) => any): boolean;
-/**
- * Whether the `Map`s are equal in value.
- */
-export declare function areMapsEqual(a: Map<any, any>, b: Map<any, any>, state: State<any>): boolean;
-/**
- * Whether the numbers are equal in value.
- */
-export declare const areNumbersEqual: typeof sameValueZeroEqual;
-/**
- * Whether the objects are equal in value.
- */
-export declare function areObjectsEqual(a: Dictionary, b: Dictionary, state: State<any>): boolean;
-/**
- * Whether the objects are equal in value with strict property checking.
- */
-export declare function areObjectsEqualStrict(a: Dictionary, b: Dictionary, state: State<any>): boolean;
-/**
- * Whether the primitive wrappers passed are equal in value.
- */
-export declare function arePrimitiveWrappersEqual(a: PrimitiveWrapper, b: PrimitiveWrapper): boolean;
-/**
- * Whether the regexps passed are equal in value.
- */
-export declare function areRegExpsEqual(a: RegExp, b: RegExp): boolean;
-/**
- * Whether the `Set`s are equal in value.
- */
-export declare function areSetsEqual(a: Set<any>, b: Set<any>, state: State<any>): boolean;
-/**
- * Whether the TypedArray instances are equal in value.
- */
-export declare function areTypedArraysEqual(a: TypedArray, b: TypedArray): boolean;
-/**
- * Whether the URL instances are equal in value.
- */
-export declare function areUrlsEqual(a: URL, b: URL): boolean;