@sepiariver/unique-set 1.0.3 → 1.1.0

package/README.md

@@ -1,8 +1,10 @@
 # @sepiariver/unique-set
 
-Extends the `add` method on the native JavaScript Set object to compare using [fast-deep-equal](https://www.npmjs.com/package/fast-deep-equal)
+Extends the `has` and `add` methods on the native JavaScript `Set` object to use [fast-deep-equal](https://www.npmjs.com/package/fast-deep-equal) as the equality algorithm.
 
-The extended method iterates through the elements of the Set until equality is found. If no elements match, the entire Set would have been iterated to determine so. For a very large Set, there is probably a better way to achieve what you're trying to do, otherwise UniqueSet can be very convenient.
+The extended methods iterate through the elements of the `UniqueSet` until equality is found. If no elements match, the entire `UniqueSet` would have been iterated to determine so. However fast `fast-deep-equal` is, calling it in a loop like this makes performance many times poorer than the native `Set`. For datasets greater than a thousand elements, there is probably a better way to achieve what you're trying to do. Otherwise, `UniqueSet` is convenient.
+
+Requires @babel/core 7+
 
 ## Installation
 
@@ -10,7 +12,7 @@ The extended method iterates through the elements of the Set until equality is f
 npm install @sepiariver/unique-set
 ```
 
-### Usage
+## Usage
 
 ```js
 const UniqueSet = require('@sepiariver/unique-set');
@@ -36,9 +38,21 @@ const data = [
   [1, 2, 3],
 ];
 
-let unique = new UniqueSet();
+let unique1 = new UniqueSet();
 data.forEach((el) => {
-  unique.add(el);
+  unique1.add(el);
 });
-console.log(unique.size); // 6 instead of 8 with Set
+let unique2 = new UniqueSet(data);
+console.log(unique1.size); // 6 instead of 8 with Set
+console.log(unique2.size); // 6
 ```
+
+## Testing
+
+1. Clone this repo
+2. `npm install`
+3. `npm run test`
+
+## Contributing
+
+Submit pull requests to https://github.com/sepiariver/unique-set/pulls

package/dist/index.js

@@ -46,14 +46,16 @@ var UniqueSet = /*#__PURE__*/function (_Set) {
   function UniqueSet() {
     _classCallCheck(this, UniqueSet);
 
-    return _super.call(this);
+    for (var _len = arguments.length, args = new Array(_len), _key = 0; _key < _len; _key++) {
+      args[_key] = arguments[_key];
+    }
+
+    return _super.call.apply(_super, [this].concat(args));
   }
 
   _createClass(UniqueSet, [{
-    key: "add",
-    value: function add(o) {
-      var isUnique = true;
-
+    key: "has",
+    value: function has(o) {
       var _iterator = _createForOfIteratorHelper(this),
           _step;
 
@@ -62,8 +64,7 @@ var UniqueSet = /*#__PURE__*/function (_Set) {
           var i = _step.value;
 
           if ((0, _fastDeepEqual["default"])(o, i)) {
-            isUnique = false;
-            break;
+            return true;
           }
         }
       } catch (err) {
@@ -72,7 +73,12 @@ var UniqueSet = /*#__PURE__*/function (_Set) {
         _iterator.f();
       }
 
-      if (isUnique) {
+      return false;
+    }
+  }, {
+    key: "add",
+    value: function add(o) {
+      if (!this.has(o)) {
         Set.prototype.add.call(this, o);
       }
     }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@sepiariver/unique-set",
-  "version": "1.0.3",
-  "description": "Extends the add method on the native JavaScript Set object to compare using fast-deep-equal",
+  "version": "1.1.0",
+  "description": "Extends the has and add methods on the native JavaScript Set object to deeply compare using fast-deep-equal",
   "main": "index.js",
   "scripts": {
     "test": "jest",

package/src/index.js

@@ -1,21 +1,22 @@
 import equal from "fast-deep-equal";
 
 class UniqueSet extends Set {
-  constructor() {
-    super();
+  constructor(...args) {
+    super(...args);
   }
-  add(o) {
-    let isUnique = true;
-    for (let i of this) {
+  has(o) {
+    for (const i of this) {
       if (equal(o, i)) {
-        isUnique = false;
-        break;
+        return true;
       }
     }
-    if (isUnique) {
+    return false;
+  }
+  add(o) {
+    if (!this.has(o)) {
       Set.prototype.add.call(this, o);
     }
   }
 }
 
-module.exports = UniqueSet;
+module.exports = UniqueSet;