Fix is-shallow-equal param types

WordPress · Dec 6, 2019 · d385221 · d385221
1 parent df5a199
commit d385221
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 4 deletions.
diff --git a/packages/is-shallow-equal/index.js b/packages/is-shallow-equal/index.js
@@ -8,12 +8,16 @@ var isShallowEqualArrays = require( './arrays' );
 
 var isArray = Array.isArray;
 
+/**
+ * @typedef {Record<any,any>} ComparableObject
+ */
+
 /**
  * Returns true if the two arrays or objects are shallow equal, or false
  * otherwise.
  *
- * @param {any[]|Object} a First object or array to compare.
- * @param {any[]|Object} b Second object or array to compare.
+ * @param {any[]|ComparableObject} a First object or array to compare.
+ * @param {any[]|ComparableObject} b Second object or array to compare.
  *
  * @return {boolean} Whether the two values are shallow equal.
  */

diff --git a/packages/is-shallow-equal/objects.js b/packages/is-shallow-equal/objects.js
@@ -5,8 +5,8 @@ var keys = Object.keys;
 /**
  * Returns true if the two objects are shallow equal, or false otherwise.
  *
- * @param {Object} a First object to compare.
- * @param {Object} b Second object to compare.
+ * @param {import('.').ComparableObject} a First object to compare.
+ * @param {import('.').ComparableObject} b Second object to compare.
  *
  * @return {boolean} Whether the two objects are shallow equal.
  */