From 3ceefc1e29d20af020f4c7c9c2d297e4a972c9f5 Mon Sep 17 00:00:00 2001
From: Muthu Kumar <muthukumar@thefeathers.in>
Date: Tue, 27 Feb 2018 09:47:06 +0530
Subject: [PATCH] Added minified version, README

---
 README.md        | 81 ++++++++++++++++++++++++++++++++++++++++++++++++
 dist/isEq.min.js | 10 ++++++
 index.js         | 94 --------------------------------------------------------
 isEq.js          | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 package.json     |  4 +--
 5 files changed, 187 insertions(+), 96 deletions(-)
 create mode 100644 README.md
 create mode 100644 dist/isEq.min.js
 delete mode 100644 index.js
 create mode 100644 isEq.js

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ab3568
--- /dev/null
+++ b/README.md
@@ -0,0 +1,81 @@
+# isEq
+
+### Deep-compare objects
+
+`isEq` is a very tiny module that deep compares objects or arrays.
+
+Although the intention is deep comparison, `isEq` can compare several datatypes.
+
+## Supports
+
+| Datatype             	| Support	|
+|---------------------	|---		|
+| Number              	| ✅ 	|
+| String              	| ✅ 	|
+| Boolean             	| ✅ 	|
+| Regexp              	| ✅ 	|
+| Object              	| ✅ 	|
+| Array               	| ✅ 	|
+| Cyclic Object/Array 	| ❌ 	|
+| Function            	| ❌ 	|
+| Symbol              	| ❌ 	|
+| Blob                	| ❌ 	|
+
+## Installation
+
+Node:
+
+```Shell
+npm install --save iseq
+```
+
+In the browser:
+```HTML
+<script src="https://unpkg.com/iseq">
+```
+
+## Usage
+
+```JavaScript
+isEq(<sourceObject>, <compareObject>, [comparisonKeys])
+```
+
+where if comparison keys are not given, `compareObject` is compared against all keys of `sourceObject`.
+
+## Example
+
+So you want to filter all the entities in `Steins;Gate` that have the property `isEvil: true`.
+
+```JavaScript
+var entities = [
+	{
+		name: 'Future Gadget Laboratory',
+		isEvil: false,
+		after: 'Disrupting the status quo',
+		"known-members": [
+			{ name: 'Okabe Rintarou', gender: 'Male', occupation: 'University student' },
+			{ name: 'Mayuri Shiina', gender: 'Female', occupation: 'Maid at May Queen' },
+			{ name: 'Itaru Hashida', gender: 'Male', occupation: 'Hacker' },
+		],
+	},
+	{
+		name: 'SERN',
+		isEvil: true,
+		after: 'IBN 5100',
+		"known-members": [
+			{ name: 'Yuugo Tennouji', gender: 'Male', occupation: 'CRT mechanic' },
+			{ name: 'Moeka Kiryū', gender: 'Female', occupation: 'Part-time editor' },
+		],
+	},
+	{
+		name: 'Strategic Focus',
+		isEvil: true,
+		after: 'Time travel',
+		"known-members": [
+			{ name: 'Alexis Leskinen', gender: 'Male', occupation: 'Professor' },
+		],
+	},
+]
+
+const evilEntities = entities.filter(eachEntity => isEq(eachEntity, { isEvil: true }, ['isEvil']));
+```
\ No newline at end of file
diff --git a/dist/isEq.min.js b/dist/isEq.min.js
new file mode 100644
index 0000000..da3ebc0
--- /dev/null
+++ b/dist/isEq.min.js
@@ -0,0 +1,10 @@
+/**
+ * Written by Muthu Kumar <https://mkr.pw>
+ * Original source: https://github.com/CodeFeathers/isEq
+ * 
+ * Deep compares objects or arrays and returns boolean.
+ * Supports Number, String, Boolean, Regexp, Objects, Arrays.
+ * 
+ * Usage: isEq(<*>, <*>, [compareKeys, ...]);
+ */
+'use strict';var _typeof=typeof Symbol==="function"&&typeof Symbol.iterator==="symbol"?function(obj){return typeof obj}:function(obj){return obj&&typeof Symbol==="function"&&obj.constructor===Symbol&&obj!==Symbol.prototype?"symbol":typeof obj};var isEq=function isEq(item1,item2,compareKeys){if((typeof item1==='undefined'?'undefined':_typeof(item1))!==(typeof item2==='undefined'?'undefined':_typeof(item2))){return false}if(Array.isArray(item1)){if(!Array.isArray(item2)){return false}}if(Array.isArray(item2)){if(!Array.isArray(item1)){return false}}if(typeof item1==='number'||typeof item1==='string'||typeof item1==='boolean'||item1===null||item1===undefined){if(item1===item2){return true}else{return false}};if(item1===NaN&&item2===NaN){return true}if(item1 instanceof RegExp){return String(item1)===String(item2)}if((typeof item1==='undefined'?'undefined':_typeof(item1))!=='object'||(typeof item2==='undefined'?'undefined':_typeof(item2))!=='object'){throw new Error('[isEq] Unhandleable input!')}var item1Keys=Object.keys(item1);var item2Keys=Object.keys(item2);if(!compareKeys){compareKeys=item1Keys;if(item1Keys.length!==item2Keys.length){return false}};if(!Array.isArray(compareKeys)){throw new Error('[isEq] third parameter should be an array of keys!')}if(compareKeys.length===0){return true}for(var KeyIndex in compareKeys){var Key=compareKeys[KeyIndex];if(Array.isArray(item1[Key])&&Array.isArray(item2[Key])){var _Key=KeyIndex};if(item1[Key]!==item2[Key]){if(_typeof(item1[Key]==='object')&&_typeof(item2[Key]==='object')||Array.isArray(item1[Key])&&Array.isArray(item2[Key])){if(!isEq(item1[Key],item2[Key])){return false;break}}else{return false;break}}};return true};module.exports=isEq;
\ No newline at end of file
diff --git a/index.js b/index.js
deleted file mode 100644
index d55fa52..0000000
--- a/index.js
+++ /dev/null
@@ -1,94 +0,0 @@
-'use strict';
-
-/**
- * ↘️↘️
- * @author Muthu Kumar <https://mkr.pw>
- * isEq(item1, item2 [, compareKeys])
- * @description Deep compares two objects or arrays and returns boolean
- * Supports Number, String, Boolean, Regexp, Objects, Arrays
- * @param {*} item1 - Object or Array to compare against.
- * @param {*} item2 - Object or Array to compare with.
- * @param {Array} [compareKeys] - Keys to compare against. Ignores other keys.
- */
-
-const isEq = (item1, item2, compareKeys) => {
-
-	// Returns false if different types are used.
-	if (typeof item1 !== typeof item2) return false;
-
-	// Arrays are of type object, hence let's go one further step
-	// to prove type inequality
-	if (Array.isArray(item1))
-		if (!Array.isArray(item2))
-			return false;
-	if (Array.isArray(item2))
-		if (!Array.isArray(item1))
-			return false;
-
-	// Since types are already equal, let's find if items are equal.
-	if ((typeof item1 === 'number') ||
-		(typeof item1 === 'string') ||
-		(typeof item1 === 'boolean') ||
-		(item1 === null) ||
-		(item1 === undefined)) {
-		if (item1 === item2) return true;
-		else return false;
-	};
-
-	// 'NaN's are special. They aren't equal to each other.
-	if (item1 === NaN && item2 === NaN) return true;
-
-	// Regexp needs to be Stringified first before comparing equality
-	if (item1 instanceof RegExp) return String(item1) === String(item2);
-
-	// If none of the above conditions returned, then check if inputs are handlable
-	if (typeof (item1) !== 'object' || typeof (item2) !== 'object')
-		throw new Error('[isEq] Unhandleable input!');
-
-	const item1Keys = Object.keys(item1);
-	const item2Keys = Object.keys(item2);
-
-	// If compare keys array is not given, let's check length of props
-	// and check second array against first.
-	if (!compareKeys) {
-		compareKeys = item1Keys;
-		if (item1Keys.length !== item2Keys.length) {
-			return false;
-		};
-	};
-
-	if(!(Array.isArray(compareKeys)))
-		throw new Error('[isEq] third parameter should be an array of keys!');
-
-	// Either both are empty objects or arrays, or compareArray is empty. Return true.
-	if(compareKeys.length === 0) return true;
-
-	// For each key in our reference...
-	for (let KeyIndex in compareKeys) {
-
-		let Key = compareKeys[KeyIndex];
-		if (Array.isArray(item1[Key]) && Array.isArray(item2[Key])) {
-			const Key = KeyIndex;
-		};
-
-		// Inequality at this point can be because it's just comparing
-		// two objects or arrays that may or may not be equivalent.
-		if (item1[Key] !== item2[Key]) {
-
-			if (typeof (item1[Key] === 'object') && typeof (item2[Key] === 'object') ||
-				(Array.isArray(item1[Key]) && Array.isArray(item2[Key]))) {
-				if (!isEq(item1[Key], item2[Key])) {
-					return false;
-					break;
-				};
-			} else {
-				return false;
-				break;
-			};
-		};
-	};
-
-	return true;
-};
-
-module.exports = isEq;
\ No newline at end of file
diff --git a/isEq.js b/isEq.js
new file mode 100644
index 0000000..9ae0c0a
--- /dev/null
+++ b/isEq.js
@@ -0,0 +1,94 @@
+'use strict';
+
+/**
+ * ↘️↘️
+ * @author Muthu Kumar <https://mkr.pw>
+ * isEq(item1, item2 [, compareKeys])
+ * @description Deep compares objects or arrays and returns boolean.
+ * Supports Number, String, Boolean, Regexp, Objects, Arrays
+ * @param {*} item1 - Object or Array to compare against.
+ * @param {*} item2 - Object or Array to compare with.
+ * @param {Array} [compareKeys] - Keys to compare against. Ignores other keys.
+ */
+
+const isEq = (item1, item2, compareKeys) => {
+
+	// Returns false if different types are used.
+	if (typeof item1 !== typeof item2) return false;
+
+	// Arrays are of type object, hence let's go one further step
+	// to prove type inequality
+	if (Array.isArray(item1))
+		if (!Array.isArray(item2))
+			return false;
+	if (Array.isArray(item2))
+		if (!Array.isArray(item1))
+			return false;
+
+	// Since types are already equal, let's find if items are equal.
+	if ((typeof item1 === 'number') ||
+		(typeof item1 === 'string') ||
+		(typeof item1 === 'boolean') ||
+		(item1 === null) ||
+		(item1 === undefined)) {
+		if (item1 === item2) return true;
+		else return false;
+	};
+
+	// 'NaN's are special. They aren't equal to each other.
+	if (item1 === NaN && item2 === NaN) return true;
+
+	// Regexp needs to be Stringified first before comparing equality
+	if (item1 instanceof RegExp) return String(item1) === String(item2);
+
+	// If none of the above conditions returned, then check if inputs are handlable
+	if (typeof (item1) !== 'object' || typeof (item2) !== 'object')
+		throw new Error('[isEq] Unhandleable input!');
+
+	const item1Keys = Object.keys(item1);
+	const item2Keys = Object.keys(item2);
+
+	// If compare keys array is not given, let's check length of props
+	// and check second array against first.
+	if (!compareKeys) {
+		compareKeys = item1Keys;
+		if (item1Keys.length !== item2Keys.length) {
+			return false;
+		};
+	};
+
+	if(!(Array.isArray(compareKeys)))
+		throw new Error('[isEq] third parameter should be an array of keys!');
+
+	// Either both are empty objects or arrays, or compareArray is empty. Return true.
+	if(compareKeys.length === 0) return true;
+
+	// For each key in our reference...
+	for (let KeyIndex in compareKeys) {
+
+		let Key = compareKeys[KeyIndex];
+		if (Array.isArray(item1[Key]) && Array.isArray(item2[Key])) {
+			const Key = KeyIndex;
+		};
+
+		// Inequality at this point can be because it's just comparing
+		// two objects or arrays that may or may not be equivalent.
+		if (item1[Key] !== item2[Key]) {
+
+			if (typeof (item1[Key] === 'object') && typeof (item2[Key] === 'object') ||
+				(Array.isArray(item1[Key]) && Array.isArray(item2[Key]))) {
+				if (!isEq(item1[Key], item2[Key])) {
+					return false;
+					break;
+				};
+			} else {
+				return false;
+				break;
+			};
+		};
+	};
+
+	return true;
+};
+
+module.exports = isEq;
\ No newline at end of file
diff --git a/package.json b/package.json
index c321506..43592ad 100644
--- a/package.json
+++ b/package.json
@@ -1,8 +1,8 @@
 {
 	"name": "iseq",
 	"version": "1.0.0",
-	"description": "Deep compare objects",
-	"main": "index.js",
+	"description": "Deep compare objects and arrays",
+	"main": "dist/iseq.js",
 	"scripts": {
 		"test": "echo \"Error: no test specified\" && exit 1"
 	},