diff --git a/package.json b/package.json index 670087e..b74834b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@ztimson/utils", - "version": "0.30.11", + "version": "0.31.0", "description": "Utility library", "author": "Zak Timson", "license": "MIT", diff --git a/src/objects.ts b/src/objects.ts index e6d03af..d62a428 100644 --- a/src/objects.ts +++ b/src/objects.ts @@ -243,48 +243,46 @@ export function includes(target: any, values: any, allowMissing = false): boolea /** * Deep check if two items are equal. - * Handles primitives, objects, arrays, functions, Date, RegExp, and circular references. + * Handles primitives, objects, arrays, functions, Date, RegExp, circular refs, + * and optional key-based exclusions. * * @param {any} a - first item to compare * @param {any} b - second item to compare - * @param {WeakMap} [seen] - Internal parameter to track circular references + * @param {string[] | ((key: string, a: any, b: any) => boolean | void)} [compare] - + * Ignore patterns (dot-path, '*' = wildcard segment, matches whole subtree) OR + * a comparator callback: return true/false to short-circuit, undefined to use default logic. + * @param {WeakMap} [seen] - Internal, tracks circular references + * @param {string} [path] - Internal, current dot-path * @returns {boolean} True if they match */ -export function isEqual(a: any, b: any, seen = new WeakMap()): boolean { - // Simple cases +export function isEqual(a: any, b: any, compare?: string[] | ((key: string, a: any, b: any) => boolean | void), seen = new WeakMap(), path = ''): boolean { + if(Array.isArray(compare)) { + if(compare.some(p => new RegExp(`^${p.replace(/[.+^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '[^.]*')}(\\.|$)`).test(path))) return true; + } else if(typeof compare === 'function') { + const r = compare(path, a, b); + if(r !== undefined) return r; + } if(a === b) return true; if(a instanceof Date && b instanceof Date) return a.getTime() === b.getTime(); if(a instanceof RegExp && b instanceof RegExp) return a.source === b.source && a.flags === b.flags; - - // Null checks if(typeof a !== 'object' || a === null || typeof b !== 'object' || b === null) { if(Number.isNaN(a) && Number.isNaN(b)) return true; - if(typeof a === 'function' && typeof b === 'function') return a.toString() === b.toString() + if(typeof a === 'function' && typeof b === 'function') return a.toString() === b.toString(); return false; } - - // Circular references if(seen.has(a)) return seen.get(a) === b; seen.set(a, b); - const isArrayA = Array.isArray(a); - const isArrayB = Array.isArray(b); - - // Array checks + const isArrayA = Array.isArray(a), isArrayB = Array.isArray(b); if(isArrayA && isArrayB) { if(a.length !== b.length) return false; - for(let i = 0; i < a.length; i++) { - if(!isEqual(a[i], b[i], seen)) return false; - } + for(let i = 0; i < a.length; i++) if(!isEqual(a[i], b[i], compare, seen, path ? `${path}.${i}` : `${i}`)) return false; return true; } if(isArrayA !== isArrayB) return false; - - // Key & value deep comparison - const keysA = Object.keys(a); - const keysB = Object.keys(b); + const keysA = Object.keys(a), keysB = Object.keys(b); if(keysA.length !== keysB.length) return false; for(const key of keysA) { - if(!Object.prototype.hasOwnProperty.call(b, key) || !isEqual(a[key], b[key], seen)) return false; + if(!Object.prototype.hasOwnProperty.call(b, key) || !isEqual(a[key], b[key], compare, seen, path ? `${path}.${key}` : key)) return false; } return true; }