🤖 Merge PR DefinitelyTyped#72512 feat(is-equal-shallow): add type support for is-equal-shallow package by @akeldamas

Co-authored-by: Jake Bailey <[email protected]>

Author: akeldamas

types/is-equal-shallow/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/is-equal-shallow/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Performs a shallow comparison between two objects.
+ *
+ * @param a - The first object to compare
+ * @param b - The second object to compare
+ * @returns `true` if the objects have identical top-level property values, otherwise `false`
+ */
+declare function isEqual(a: object, b: object): boolean;
+
+export = isEqual;

types/is-equal-shallow/is-equal-shallow-tests.ts

@@ -0,0 +1,20 @@
+import isEqual from "is-equal-shallow";
+
+// $ExpectType boolean
+isEqual({ a: 1 }, { a: 1 });
+
+// $ExpectType boolean
+isEqual({ a: 1 }, { a: 2 });
+
+// @ts-expect-error
+isEqual(1, 1);
+
+// @ts-expect-error
+isEqual("test", "test");
+
+// Nested objects (shallow comparison only checks top level)
+const obj1 = { a: { b: 1 } };
+const obj2 = { a: { b: 1 } };
+
+// $ExpectType boolean
+isEqual(obj1, obj2);

types/is-equal-shallow/package.json

@@ -0,0 +1,17 @@
+{
+    "private": true,
+    "name": "@types/is-equal-shallow",
+    "version": "0.1.9999",
+    "projects": [
+        "https://github.com/jonschlinkert/is-equal-shallow"
+    ],
+    "devDependencies": {
+        "@types/is-equal-shallow": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Laurens Tobias",
+            "githubUsername": "akeldamas"
+        }
+    ]
+}

types/is-equal-shallow/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "is-equal-shallow-tests.ts"
+    ]
+}