Rename isEqual to eqDeep.

This commit is contained in:
John-David Dalton
2017-01-29 23:51:40 -08:00
parent 41133cf40f
commit a6ff1ea9d5

33
eqDeep.js Normal file
View File

@@ -0,0 +1,33 @@
import baseIsEqual from './.internal/baseIsEqual.js';
/**
* Performs a deep comparison between two values to determine if they are
* equivalent.
*
* **Note:** This method supports comparing arrays, array buffers, booleans,
* date objects, error objects, maps, numbers, `Object` objects, regexes,
* sets, strings, symbols, and typed arrays. `Object` objects are compared
* by their own, not inherited, enumerable properties. Functions and DOM
* nodes are compared by strict equality, i.e. `===`.
*
* @since 0.1.0
* @category Lang
* @param {*} value The value to compare.
* @param {*} other The other value to compare.
* @returns {boolean} Returns `true` if the values are equivalent, else `false`.
* @example
*
* const object = { 'a': 1 };
* const other = { 'a': 1 };
*
* isEqual(object, other);
* // => true
*
* object === other;
* // => false
*/
function isEqual(value, other) {
return baseIsEqual(value, other);
}
export default isEqual;