cacheable 1.7.0 → 1.7.1

package/README.md

@@ -261,13 +261,20 @@ By default we use lazy expiration deletion which means on `get` and `getMany` ty
 ### CacheableMemory API
 
 * `set(key, value, ttl?)`: Sets a value in the cache.
+* `setMany([{key, value, ttl?}])`: Sets multiple values in the cache from `CachableItem`.
 * `get(key)`: Gets a value from the cache.
+* `getMany([keys])`: Gets multiple values from the cache.
+* `getRaw(key)`: Gets a value from the cache as `CacheableStoreItem`.
+* `getManyRaw([keys])`: Gets multiple values from the cache as `CacheableStoreItem`.
 * `has(key)`: Checks if a value exists in the cache.
 * `delete(key)`: Deletes a value from the cache.
+* `deleteMany([keys])`: Deletes multiple values from the cache.
+* `take(key)`: Takes a value from the cache and deletes it.
+* `takeMany([keys])`: Takes multiple values from the cache and deletes them.
 * `clear()`: Clears the cache.
 * `size()`: The number of keys in the cache.
 * `keys()`: The keys in the cache.
-* `items()`: The items in the cache as `{ key, value, expires? }`.
+* `items()`: The items in the cache as `CacheableStoreItem` example `{ key, value, expires? }`.
 * `checkExpired()`: Checks for expired keys in the cache. This is used by the `checkInterval` property.
 * `startIntervalCheck()`: Starts the interval check for expired keys if `checkInterval` is above 0 ms.
 * `stopIntervalCheck()`: Stops the interval check for expired keys.

package/dist/index.cjs

@@ -262,6 +262,13 @@ var CacheableMemory = class {
     }
     return this.clone(item.value);
   }
+  getMany(keys) {
+    const result = new Array();
+    for (const key of keys) {
+      result.push(this.get(key));
+    }
+    return result;
+  }
   getRaw(key) {
     const store = this.getStore(key);
     const item = store.get(key);
@@ -275,6 +282,13 @@ var CacheableMemory = class {
     this.lruMoveToFront(key);
     return item;
   }
+  getManyRaw(keys) {
+    const result = new Array();
+    for (const key of keys) {
+      result.push(this.getRaw(key));
+    }
+    return result;
+  }
   set(key, value, ttl) {
     const store = this.getStore(key);
     let expires;
@@ -305,6 +319,11 @@ var CacheableMemory = class {
       expires
     });
   }
+  setMany(items) {
+    for (const item of items) {
+      this.set(item.key, item.value, item.ttl);
+    }
+  }
   has(key) {
     const item = this.get(key);
     return Boolean(item);
@@ -317,10 +336,22 @@ var CacheableMemory = class {
     this.delete(key);
     return item;
   }
+  takeMany(keys) {
+    const result = new Array();
+    for (const key of keys) {
+      result.push(this.take(key));
+    }
+    return result;
+  }
   delete(key) {
     const store = this.getStore(key);
     store.delete(key);
   }
+  deleteMany(keys) {
+    for (const key of keys) {
+      this.delete(key);
+    }
+  }
   clear() {
     this._hash0.clear();
     this._hash1.clear();
@@ -483,32 +514,30 @@ var KeyvCacheableMemory = class {
     }
     return void 0;
   }
-  set(key, value, ttl) {
+  async getMany(keys) {
+    const result = this._cache.getMany(keys);
+    return result;
+  }
+  async set(key, value, ttl) {
     this._cache.set(key, value, ttl);
   }
+  async setMany(values) {
+    this._cache.setMany(values);
+  }
   async delete(key) {
     this._cache.delete(key);
     return true;
   }
+  async deleteMany(key) {
+    this._cache.deleteMany(key);
+    return true;
+  }
   async clear() {
     this._cache.clear();
   }
   async has(key) {
     return this._cache.has(key);
   }
-  async getMany(keys) {
-    const result = [];
-    for (const key of keys) {
-      result.push(this._cache.get(key));
-    }
-    return result;
-  }
-  async deleteMany(key) {
-    for (const k of key) {
-      this._cache.delete(k);
-    }
-    return true;
-  }
   on(event, listener) {
     return this;
   }

package/dist/index.d.cts

@@ -46,17 +46,23 @@ declare class CacheableStats {
     resetStoreValues(): void;
 }
 
-type CacheableMemoryOptions = {
+type CacheableItem = {
+    key: string;
+    value: any;
     ttl?: number | string;
-    useClone?: boolean;
-    lruSize?: number;
-    checkInterval?: number;
 };
-type CacheableItem$1 = {
+type CacheableStoreItem = {
     key: string;
     value: any;
     expires?: number;
 };
+
+type CacheableMemoryOptions = {
+    ttl?: number | string;
+    useClone?: boolean;
+    lruSize?: number;
+    checkInterval?: number;
+};
 declare class CacheableMemory {
     private readonly _hashCache;
     private readonly _hash0;
@@ -86,13 +92,18 @@ declare class CacheableMemory {
     set checkInterval(value: number);
     get size(): number;
     get keys(): IterableIterator<string>;
-    get items(): IterableIterator<CacheableItem$1>;
+    get items(): IterableIterator<CacheableStoreItem>;
     get<T>(key: string): any;
-    getRaw(key: string): CacheableItem$1 | undefined;
+    getMany<T>(keys: string[]): any[];
+    getRaw(key: string): CacheableStoreItem | undefined;
+    getManyRaw(keys: string[]): Array<CacheableStoreItem | undefined>;
     set(key: string, value: any, ttl?: number | string): void;
+    setMany(items: CacheableItem[]): void;
     has(key: string): boolean;
     take<T>(key: string): any;
+    takeMany<T>(keys: string[]): any[];
     delete(key: string): void;
+    deleteMany(keys: string[]): void;
     clear(): void;
     hashKey(key: string): number;
     getStore(key: string): Map<string, any>;
@@ -114,12 +125,17 @@ declare class KeyvCacheableMemory implements KeyvStoreAdapter {
     private readonly _cache;
     constructor(options?: CacheableMemoryOptions);
     get<Value>(key: string): Promise<StoredData<Value> | undefined>;
-    set(key: string, value: any, ttl?: number): void;
+    getMany<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
+    set(key: string, value: any, ttl?: number): Promise<void>;
+    setMany(values: Array<{
+        key: string;
+        value: any;
+        ttl?: number;
+    }>): Promise<void>;
     delete(key: string): Promise<boolean>;
+    deleteMany?(key: string[]): Promise<boolean>;
     clear(): Promise<void>;
     has?(key: string): Promise<boolean>;
-    getMany?<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
-    deleteMany?(key: string[]): Promise<boolean>;
     on(event: string, listener: (...arguments_: any[]) => void): this;
 }
 
@@ -139,11 +155,6 @@ declare enum CacheableHooks {
 declare enum CacheableEvents {
     ERROR = "error"
 }
-type CacheableItem = {
-    key: string;
-    value: unknown;
-    ttl?: number | string;
-};
 type CacheableOptions = {
     primary?: Keyv | KeyvStoreAdapter;
     secondary?: Keyv | KeyvStoreAdapter;

package/dist/index.d.ts

@@ -46,17 +46,23 @@ declare class CacheableStats {
     resetStoreValues(): void;
 }
 
-type CacheableMemoryOptions = {
+type CacheableItem = {
+    key: string;
+    value: any;
     ttl?: number | string;
-    useClone?: boolean;
-    lruSize?: number;
-    checkInterval?: number;
 };
-type CacheableItem$1 = {
+type CacheableStoreItem = {
     key: string;
     value: any;
     expires?: number;
 };
+
+type CacheableMemoryOptions = {
+    ttl?: number | string;
+    useClone?: boolean;
+    lruSize?: number;
+    checkInterval?: number;
+};
 declare class CacheableMemory {
     private readonly _hashCache;
     private readonly _hash0;
@@ -86,13 +92,18 @@ declare class CacheableMemory {
     set checkInterval(value: number);
     get size(): number;
     get keys(): IterableIterator<string>;
-    get items(): IterableIterator<CacheableItem$1>;
+    get items(): IterableIterator<CacheableStoreItem>;
     get<T>(key: string): any;
-    getRaw(key: string): CacheableItem$1 | undefined;
+    getMany<T>(keys: string[]): any[];
+    getRaw(key: string): CacheableStoreItem | undefined;
+    getManyRaw(keys: string[]): Array<CacheableStoreItem | undefined>;
     set(key: string, value: any, ttl?: number | string): void;
+    setMany(items: CacheableItem[]): void;
     has(key: string): boolean;
     take<T>(key: string): any;
+    takeMany<T>(keys: string[]): any[];
     delete(key: string): void;
+    deleteMany(keys: string[]): void;
     clear(): void;
     hashKey(key: string): number;
     getStore(key: string): Map<string, any>;
@@ -114,12 +125,17 @@ declare class KeyvCacheableMemory implements KeyvStoreAdapter {
     private readonly _cache;
     constructor(options?: CacheableMemoryOptions);
     get<Value>(key: string): Promise<StoredData<Value> | undefined>;
-    set(key: string, value: any, ttl?: number): void;
+    getMany<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
+    set(key: string, value: any, ttl?: number): Promise<void>;
+    setMany(values: Array<{
+        key: string;
+        value: any;
+        ttl?: number;
+    }>): Promise<void>;
     delete(key: string): Promise<boolean>;
+    deleteMany?(key: string[]): Promise<boolean>;
     clear(): Promise<void>;
     has?(key: string): Promise<boolean>;
-    getMany?<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
-    deleteMany?(key: string[]): Promise<boolean>;
     on(event: string, listener: (...arguments_: any[]) => void): this;
 }
 
@@ -139,11 +155,6 @@ declare enum CacheableHooks {
 declare enum CacheableEvents {
     ERROR = "error"
 }
-type CacheableItem = {
-    key: string;
-    value: unknown;
-    ttl?: number | string;
-};
 type CacheableOptions = {
     primary?: Keyv | KeyvStoreAdapter;
     secondary?: Keyv | KeyvStoreAdapter;

package/dist/index.js

@@ -231,6 +231,13 @@ var CacheableMemory = class {
     }
     return this.clone(item.value);
   }
+  getMany(keys) {
+    const result = new Array();
+    for (const key of keys) {
+      result.push(this.get(key));
+    }
+    return result;
+  }
   getRaw(key) {
     const store = this.getStore(key);
     const item = store.get(key);
@@ -244,6 +251,13 @@ var CacheableMemory = class {
     this.lruMoveToFront(key);
     return item;
   }
+  getManyRaw(keys) {
+    const result = new Array();
+    for (const key of keys) {
+      result.push(this.getRaw(key));
+    }
+    return result;
+  }
   set(key, value, ttl) {
     const store = this.getStore(key);
     let expires;
@@ -274,6 +288,11 @@ var CacheableMemory = class {
       expires
     });
   }
+  setMany(items) {
+    for (const item of items) {
+      this.set(item.key, item.value, item.ttl);
+    }
+  }
   has(key) {
     const item = this.get(key);
     return Boolean(item);
@@ -286,10 +305,22 @@ var CacheableMemory = class {
     this.delete(key);
     return item;
   }
+  takeMany(keys) {
+    const result = new Array();
+    for (const key of keys) {
+      result.push(this.take(key));
+    }
+    return result;
+  }
   delete(key) {
     const store = this.getStore(key);
     store.delete(key);
   }
+  deleteMany(keys) {
+    for (const key of keys) {
+      this.delete(key);
+    }
+  }
   clear() {
     this._hash0.clear();
     this._hash1.clear();
@@ -452,32 +483,30 @@ var KeyvCacheableMemory = class {
     }
     return void 0;
   }
-  set(key, value, ttl) {
+  async getMany(keys) {
+    const result = this._cache.getMany(keys);
+    return result;
+  }
+  async set(key, value, ttl) {
     this._cache.set(key, value, ttl);
   }
+  async setMany(values) {
+    this._cache.setMany(values);
+  }
   async delete(key) {
     this._cache.delete(key);
     return true;
   }
+  async deleteMany(key) {
+    this._cache.deleteMany(key);
+    return true;
+  }
   async clear() {
     this._cache.clear();
   }
   async has(key) {
     return this._cache.has(key);
   }
-  async getMany(keys) {
-    const result = [];
-    for (const key of keys) {
-      result.push(this._cache.get(key));
-    }
-    return result;
-  }
-  async deleteMany(key) {
-    for (const k of key) {
-      this._cache.delete(k);
-    }
-    return true;
-  }
   on(event, listener) {
     return this;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cacheable",
-  "version": "1.7.0",
+  "version": "1.7.1",
   "description": "Simple Caching Engine using Keyv",
   "type": "module",
   "main": "./dist/index.cjs",