Removed redundant type, added index.d.ts to package.json, added JSDoc

Author: Floofies

dist/index.d.ts

@@ -0,0 +1 @@
+export default function testDiff(input1:any|object|Array<any>, input2:any|object|Array<any>, deep:boolean):boolean;

dist/index.js

@@ -7,7 +7,12 @@ function testValue(value1, value2) {
         return true;
     return false;
 }
-// Returns true if obj1 differs in any way from obj2.
+/**
+ * Returns true if input1 differs in any way from input2. Performs "deep" object/array traversal by default, comparing all reachable values.
+ * @param {any} input1 A value/object to compare against input2.
+ * @param {any} input2 A value/object to compare against input1.
+ * @param {boolean} [deep=true] Set this operand to false to disable traversal and nested comparisons.
+ */
 export default function testDiff(obj1, obj2, deep) {
     if (deep === void 0) { deep = true; }
     if ((obj1 === null) || (obj2 === null) || ((typeof obj1) !== "object") || ((typeof obj2) !== "object"))

package.json

@@ -1,33 +1,34 @@
 {
-  "name": "js-testdiff",
-  "type": "module",
-  "version": "1.0.2",
-  "description": "The \"testDiff\" deep diff/test function from Differentia.js, ported to TypeScript. Returns true if input 1 differs in any way from input 2. Performs deep object search by default, works OK with circular references.",
-  "main": "dist/index.js",
-  "scripts": {
-    "test": "npm run build",
-    "build": "tsc src/index.ts src/lib/unitTest.ts --module es6 --lib es6 --outDir dist/ && node test.mjs"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Floofies/js-testdiff.git"
-  },
-  "keywords": [
-    "test",
-    "diff",
-    "object",
-    "comparison",
-    "compare",
-    "deep",
-    "circular"
-  ],
-  "author": "Dani Glore",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/Floofies/js-testdiff/issues"
-  },
-  "homepage": "https://github.com/Floofies/js-testdiff#readme",
-  "devDependencies": {
-    "@types/node": "^18.15.13"
-  }
+	"name": "js-testdiff",
+	"type": "module",
+	"version": "1.0.2",
+	"description": "The \"testDiff\" deep diff/test function from Differentia.js, ported to TypeScript. Returns true if input 1 differs in any way from input 2. Performs deep object search by default, works OK with circular references.",
+	"main": "dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"test": "npm run build",
+		"build": "tsc src/index.ts src/lib/unitTest.ts --module es6 --lib es6 --outDir dist/ && cp src/index.d.ts dist/ && node test.mjs"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Floofies/js-testdiff.git"
+	},
+	"keywords": [
+		"test",
+		"diff",
+		"object",
+		"comparison",
+		"compare",
+		"deep",
+		"circular"
+	],
+	"author": "Dani Glore",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/Floofies/js-testdiff/issues"
+	},
+	"homepage": "https://github.com/Floofies/js-testdiff#readme",
+	"devDependencies": {
+		"@types/node": "^18.15.13"
+	}
 }

src/index.d.ts

@@ -0,0 +1 @@
+export default function testDiff(input1:any|object|Array<any>, input2:any|object|Array<any>, deep:boolean):boolean;

src/index.ts

@@ -1,7 +1,6 @@
 type searchObj = any|object|Array<any>;
 type objPair = {obj1:searchObj, obj2: searchObj};
-type Primitive = symbol|boolean|string|number|null|undefined;
-function testValue(value1:Primitive, value2:Primitive):boolean {
+function testValue(value1:any, value2:any):boolean {
 	if ((typeof value1) !== (typeof value2))
 		return true;
 	if(Number.isNaN(value1) || Number.isNaN(value2))
@@ -10,7 +9,12 @@ function testValue(value1:Primitive, value2:Primitive):boolean {
 		return true;
 	return false;
 }
-// Returns true if obj1 differs in any way from obj2.
+/**
+ * Returns true if input1 differs in any way from input2. Performs "deep" object/array traversal by default, comparing all reachable values.
+ * @param {any} input1 A value/object to compare against input2.
+ * @param {any} input2 A value/object to compare against input1.
+ * @param {boolean} [deep=true] Set this operand to false to disable traversal and nested comparisons.
+ */
 export default function testDiff(obj1:searchObj, obj2:searchObj, deep:boolean = true):boolean {
 	if((obj1 === null) || (obj2 === null) || ((typeof obj1) !== "object") || ((typeof obj2) !== "object"))
 		return testValue(obj1, obj2);