feat: add len method to expose store length (#47)

README.md

@@ -65,6 +65,7 @@ store.clear();                        // Clean all key/data
 store.keys();                         // Returns an array of all the keys
 store.forEach(callback);              // Loop traversal, return false to end traversal
 store.search(string);                 // Search method
+store.len();                          // Returns store length
 
 store.has(key); //⇒ Determine if there is a return true/false
 
@@ -160,6 +161,14 @@ store.remove('w1');  // Delete w1 and return the value of w1
 store('w1', false)   // So also delete w1
 ```
 
+### len
+
+Returns the length of the store `store.len()`
+
+```js
+store.len();  //⇒ 10
+```
+
 ### forEach
 
 Loop traversal, return `false` to end the traversal

dist/store.cjs.js

@@ -2,7 +2,7 @@
  * storejs v2.0.7
  * Local storage localstorage package provides a simple API
  * 
- * Copyright (c) 2023 kenny wang <[email protected]>
+ * Copyright (c) 2024 kenny wang <[email protected]>
  * https://jaywcjlove.github.io/store.js/
  * 
  * Licensed under the MIT license.
@@ -144,6 +144,9 @@ Store.prototype = {
       if (arr[i].indexOf(str) > -1) dt[arr[i]] = this.get(arr[i]);
     }
     return dt;
+  },
+  len: function len() {
+    return storage.length;
   }
 };
 var _Store = null;

dist/store.esm.js

@@ -2,7 +2,7 @@
  * storejs v2.0.7
  * Local storage localstorage package provides a simple API
  * 
- * Copyright (c) 2023 kenny wang <[email protected]>
+ * Copyright (c) 2024 kenny wang <[email protected]>
  * https://jaywcjlove.github.io/store.js/
  * 
  * Licensed under the MIT license.
@@ -142,6 +142,9 @@ Store.prototype = {
       if (arr[i].indexOf(str) > -1) dt[arr[i]] = this.get(arr[i]);
     }
     return dt;
+  },
+  len: function len() {
+    return storage.length;
   }
 };
 var _Store = null;

dist/store.js

@@ -2,7 +2,7 @@
  * storejs v2.0.7
  * Local storage localstorage package provides a simple API
  * 
- * Copyright (c) 2023 kenny wang <[email protected]>
+ * Copyright (c) 2024 kenny wang <[email protected]>
  * https://jaywcjlove.github.io/store.js/
  * 
  * Licensed under the MIT license.
@@ -148,6 +148,9 @@
         if (arr[i].indexOf(str) > -1) dt[arr[i]] = this.get(arr[i]);
       }
       return dt;
+    },
+    len: function len() {
+      return storage.length;
     }
   };
   var _Store = null;

src/__test__/store.test.js

@@ -151,3 +151,12 @@ test('Test Change localstorage', () => {
   })).toEqual(store);
   expect(store.get()).toEqual({ "name6": 123, "name6,name7": "keytest", "test": [3, 4, 5] });
 });
+
+test('Get store length', () => {
+  store.clear()
+  store.set('name6', 'value6')
+  store.set('name7', 'value7')
+  expect(store.len()).toEqual(2);
+  store.clear()
+  expect(store.len()).toEqual(0);
+});

src/main.js

@@ -119,6 +119,9 @@ Store.prototype = {
       if (arr[i].indexOf(str) > -1) dt[arr[i]] = this.get(arr[i]);
     }
     return dt;
+  },
+  len: function () {
+    return storage.length;
   }
 }
 

types/index.d.ts

@@ -30,6 +30,8 @@ declare class Store {
   search(keyword: string): Record<string, any>
 
   clear(): Store
+
+  len(): number
 }
 
 declare let s: typeof store & Store