Performance improvement

Author: rajkumardusad

README.md

@@ -41,18 +41,18 @@ const cache = new Cache();
 cache.set("a", 10);
 
 // Check data exists in cache
-cache.has("a");
+cache.has("a"); // true
 
 // Get data from cache
-console.log(cache.get("a"));
+console.log(cache.get("a")); // 10
 
 // Get all data from cache
 cache.forEach(function (data) {
   console.log(data); // { a: 10 }
 });
 
 // Get all data to array
-console.log(cache.toArray());
+console.log(cache.toArray()); // [ { a: 10 } ]
 
 // Delete data from cache
 cache.delete("a");
@@ -61,24 +61,27 @@ cache.delete("a");
 cache.clear();
 ```
 
-## Create a new cache object
+## Create a new cache
 
 To create a new cache we need to create a new instance of lrujs. While creating a new cache we can set the configuration like cache max length and ttl, but it is not mandatory and if we not set any configuration then the default values are used.
 
 Defination:
+
 ```js
 const cache = new Cache(options);
 ```
 
 Where options are the following:
+
 - `maxLength` : max length is a cache max length, max length is a positive integer value. The default value is 0, if the value is 0 then it will not check the max length.
 - `ttl` : is cache expires time in milliseconds, the default value is 0 and if value if 0 it will not check the ttl.
-- `interval` : interval is the time interval in milliseconds, after every interval all the expired values are automatically removed. Default value is 0 and if value is 0 the it will not removes expired values automatically, but don't worry expired items are treated as missing, and deleted when they are fetched.
+- `interval` : interval is the time interval in milliseconds, after every interval all the expired items are automatically removed. Default value is 0 and if value is 0 the it will not removes expired items automatically, but don't worry expired items are treated as missing, and deleted when they are fetched.
 - `enableInterval` : enableInterval is a boolean value that is used to enable and disable the interval, the default value is false and if value is explicitly set false then it will not run the interval even if the interval time is set.
 
-Lrujs support TTL, but it is not a TTL cache, and also does not make strong TTL guarantees. When interval is set expired values are removed from cache periodically.
+Lrujs support TTL, but it is not a TTL cache, and also does not make strong TTL guarantees. When ttl interval is set, expired items are removed from cache periodically.
 
 Example:
+
 ```js
 const Cache = require("@opensnip/lrujs");
 
@@ -94,7 +97,7 @@ const cache = new Cache({
 
 In lrujs any value (both objects and primitive values) may be used as either a key or a value, duplicate keys not allowed and if duplicate item is inserted it will be replaced by the new item.
 
-```js
+````js
 // Add new data in cache
 cache.set("a", 10);
 
@@ -111,7 +114,7 @@ By default the configuration TTL value is used for every item, but we can set TT
 ```js
 // Add new data in cache
 cache.set("b", 10, { ttl: 200 }); // Expires after 200 ms
-```
+````
 
 ## Get data from cache
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opensnip/lrujs",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Fast and lightweight lru cache for javascript",
   "main": "index.mjs",
   "type": "module",

src/cache.cjs

@@ -103,7 +103,7 @@ module.exports = class Cache {
     // Insert a new node at head
     const existingNode = this.#cache.get(key);
     // Update node data if node is already exists
-    if (existingNode instanceof Node) {
+    if (typeof existingNode !== "undefined") {
       existingNode.value = nodeValue;
       // Move current node to the head
       this.#linkedList.setHead(existingNode);
@@ -126,7 +126,7 @@ module.exports = class Cache {
 
       const node = this.#cache.get(key);
 
-      if (node instanceof Node) {
+      if (typeof node !== "undefined") {
         // Check node is live or not
         if (this.#isStale(node)) {
           this.delete(key);
@@ -156,15 +156,15 @@ module.exports = class Cache {
   delete(key) {
     const node = this.#cache.get(key);
 
-    if (node instanceof Node) {
+    if (typeof node !== "undefined") {
       this.#linkedList.delete(node);
       // Delete node
       this.#cache.delete(key);
     }
   }
 
   #evict() {
-    if (this.#linkedList.tail == null) return;
+    if (this.#linkedList.tail === null) return;
     if (this.length !== this.#config.maxLength) return;
     this.delete(this.#linkedList.tail.value.key);
   }
@@ -183,7 +183,7 @@ module.exports = class Cache {
 
     this.#config.intervalId = setInterval(
       function (cache) {
-        if (cache.length == 0) return;
+        if (cache.length === 0) return;
         cache.forEach(function (data) {
           // Automatically invalidate expired cache
         });
@@ -202,7 +202,7 @@ module.exports = class Cache {
   has(key) {
     const node = this.#cache.get(key);
 
-    if (node instanceof Node) {
+    if (typeof node !== "undefined") {
       // Check node is live or not
       if (this.#isStale(node)) {
         this.delete(key);

src/cache.mjs

@@ -103,7 +103,7 @@ export default class Cache {
     // Insert a new node at head
     const existingNode = this.#cache.get(key);
     // Update node data if node is already exists
-    if (existingNode instanceof Node) {
+    if (typeof existingNode !== undefined) {
       existingNode.value = nodeValue;
       // Move current node to the head
       this.#linkedList.setHead(existingNode);
@@ -126,7 +126,7 @@ export default class Cache {
 
       const node = this.#cache.get(key);
 
-      if (node instanceof Node) {
+      if (typeof node !== undefined) {
         // Check node is live or not
         if (this.#isStale(node)) {
           this.delete(key);
@@ -156,15 +156,15 @@ export default class Cache {
   delete(key) {
     const node = this.#cache.get(key);
 
-    if (node instanceof Node) {
+    if (typeof node !== undefined) {
       this.#linkedList.delete(node);
       // Delete node
       this.#cache.delete(key);
     }
   }
 
   #evict() {
-    if (this.#linkedList.tail == null) return;
+    if (this.#linkedList.tail === null) return;
     if (this.length !== this.#config.maxLength) return;
     this.delete(this.#linkedList.tail.value.key);
   }
@@ -183,7 +183,7 @@ export default class Cache {
 
     this.#config.intervalId = setInterval(
       function (cache) {
-        if (cache.length == 0) return;
+        if (cache.length === 0) return;
         cache.forEach(function (data) {
           // Automatically invalidate expired cache
         });
@@ -202,7 +202,7 @@ export default class Cache {
   has(key) {
     const node = this.#cache.get(key);
 
-    if (node instanceof Node) {
+    if (typeof node !== undefined) {
       // Check node is live or not
       if (this.#isStale(node)) {
         this.delete(key);

src/linkedlist/index.cjs

@@ -124,8 +124,8 @@ module.exports = class LinkedList {
     }
     tmpRight.prev = leftNode.prev;
     tmpRight.next = leftNode.next;
-    if (leftNode == this.#head) this.#head = tmpRight;
-    if (leftNode == this.#tail) this.#tail = tmpRight;
+    if (leftNode === this.#head) this.#head = tmpRight;
+    if (leftNode === this.#tail) this.#tail = tmpRight;
 
     // Replace right node with left node
     let tmpLeft = new Node(leftNode.value);
@@ -137,8 +137,8 @@ module.exports = class LinkedList {
     }
     tmpLeft.prev = rightNode.prev;
     tmpLeft.next = rightNode.next;
-    if (rightNode == this.#head) this.#head = tmpLeft;
-    if (rightNode == this.#tail) this.#tail = tmpLeft;
+    if (rightNode === this.#head) this.#head = tmpLeft;
+    if (rightNode === this.#tail) this.#tail = tmpLeft;
 
     delete leftNode.next;
     delete leftNode.prev;
@@ -150,7 +150,7 @@ module.exports = class LinkedList {
   }
 
   deleteHead() {
-    if (this.#head == null) return;
+    if (this.#head === null) return;
     if (this.#head.next != null) {
       this.#head.next.prev = null;
     }
@@ -160,7 +160,7 @@ module.exports = class LinkedList {
   }
 
   deleteTail() {
-    if (this.#tail == null) return;
+    if (this.#tail === null) return;
     if (this.#tail.prev != null) {
       this.#tail.prev.next = null;
     }
@@ -170,9 +170,6 @@ module.exports = class LinkedList {
   }
 
   delete(node) {
-    if (!(node instanceof Node)) {
-      throw new TypeError("node should be a valid Node instance");
-    }
     this.detach(node);
     delete node.prev;
     delete node.next;

src/linkedlist/index.mjs

@@ -124,8 +124,8 @@ export default class LinkedList {
     }
     tmpRight.prev = leftNode.prev;
     tmpRight.next = leftNode.next;
-    if (leftNode == this.#head) this.#head = tmpRight;
-    if (leftNode == this.#tail) this.#tail = tmpRight;
+    if (leftNode === this.#head) this.#head = tmpRight;
+    if (leftNode === this.#tail) this.#tail = tmpRight;
 
     // Replace right node with left node
     let tmpLeft = new Node(leftNode.value);
@@ -137,8 +137,8 @@ export default class LinkedList {
     }
     tmpLeft.prev = rightNode.prev;
     tmpLeft.next = rightNode.next;
-    if (rightNode == this.#head) this.#head = tmpLeft;
-    if (rightNode == this.#tail) this.#tail = tmpLeft;
+    if (rightNode === this.#head) this.#head = tmpLeft;
+    if (rightNode === this.#tail) this.#tail = tmpLeft;
 
     delete leftNode.next;
     delete leftNode.prev;
@@ -150,7 +150,7 @@ export default class LinkedList {
   }
 
   deleteHead() {
-    if (this.#head == null) return;
+    if (this.#head === null) return;
     if (this.#head.next != null) {
       this.#head.next.prev = null;
     }
@@ -160,7 +160,7 @@ export default class LinkedList {
   }
 
   deleteTail() {
-    if (this.#tail == null) return;
+    if (this.#tail === null) return;
     if (this.#tail.prev != null) {
       this.#tail.prev.next = null;
     }
@@ -170,9 +170,6 @@ export default class LinkedList {
   }
 
   delete(node) {
-    if (!(node instanceof Node)) {
-      throw new TypeError("node should be a valid Node instance");
-    }
     this.detach(node);
     delete node.prev;
     delete node.next;