@cacheable/memory 1.0.0 → 1.0.1

package/README.md

@@ -4,8 +4,8 @@
 
 [![codecov](https://codecov.io/gh/jaredwray/cacheable/graph/badge.svg?token=lWZ9OBQ7GM)](https://codecov.io/gh/jaredwray/cacheable)
 [![tests](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml/badge.svg)](https://github.com/jaredwray/cacheable/actions/workflows/tests.yml)
-[![npm](https://img.shields.io/npm/dm/cacheable.svg)](https://www.npmjs.com/package/cacheable)
-[![npm](https://img.shields.io/npm/v/cacheable)](https://www.npmjs.com/package/cacheable)
+[![npm](https://img.shields.io/npm/dm/@cacheable/memory.svg)](https://www.npmjs.com/package/@cacheable/memory)
+[![npm](https://img.shields.io/npm/v/@cacheable/memory.svg)](https://www.npmjs.com/package/@cacheable/memory)
 [![license](https://img.shields.io/github/license/jaredwray/cacheable)](https://github.com/jaredwray/cacheable/blob/main/LICENSE)
 
 You can use `CacheableMemory` as a standalone cache or as a primary store for `cacheable`. You can also set the `useClones` property to `false` if you want to use the same reference for the values. This is useful if you are using large objects and want to save memory. The `lruSize` property is the size of the LRU cache and is set to `0` by default which is unlimited. When setting the `lruSize` property it will limit the number of keys in the cache.

package/dist/index.cjs

@@ -28,13 +28,12 @@ __export(index_exports, {
   maximumMapSize: () => maximumMapSize
 });
 module.exports = __toCommonJS(index_exports);
-var import_hookified = require("hookified");
 var import_memoize = require("@cacheable/memoize");
 var import_utils = require("@cacheable/utils");
+var import_hookified = require("hookified");
 
 // src/memory-lru.ts
 var ListNode = class {
-  // eslint-disable-next-line @typescript-eslint/parameter-properties
   value;
   prev = void 0;
   next = void 0;
@@ -114,7 +113,10 @@ var CacheableMemory = class extends import_hookified.Hookified {
   _storeHashSize = defaultStoreHashSize;
   _storeHashAlgorithm = import_utils.HashAlgorithm.DJB2;
   // Default is djb2Hash
-  _store = Array.from({ length: this._storeHashSize }, () => /* @__PURE__ */ new Map());
+  _store = Array.from(
+    { length: this._storeHashSize },
+    () => /* @__PURE__ */ new Map()
+  );
   _ttl;
   // Turned off by default
   _useClone = true;
@@ -142,7 +144,12 @@ var CacheableMemory = class extends import_hookified.Hookified {
     }
     if (options?.lruSize) {
       if (options.lruSize > maximumMapSize) {
-        this.emit("error", new Error(`LRU size cannot be larger than ${maximumMapSize} due to Map limitations.`));
+        this.emit(
+          "error",
+          new Error(
+            `LRU size cannot be larger than ${maximumMapSize} due to Map limitations.`
+          )
+        );
       } else {
         this._lruSize = options.lruSize;
       }
@@ -153,7 +160,10 @@ var CacheableMemory = class extends import_hookified.Hookified {
     if (options?.storeHashAlgorithm) {
       this._storeHashAlgorithm = options.storeHashAlgorithm;
     }
-    this._store = Array.from({ length: this._storeHashSize }, () => /* @__PURE__ */ new Map());
+    this._store = Array.from(
+      { length: this._storeHashSize },
+      () => /* @__PURE__ */ new Map()
+    );
     this.startIntervalCheck();
   }
   /**
@@ -197,7 +207,12 @@ var CacheableMemory = class extends import_hookified.Hookified {
    */
   set lruSize(value) {
     if (value > maximumMapSize) {
-      this.emit("error", new Error(`LRU size cannot be larger than ${maximumMapSize} due to Map limitations.`));
+      this.emit(
+        "error",
+        new Error(
+          `LRU size cannot be larger than ${maximumMapSize} due to Map limitations.`
+        )
+      );
       return;
     }
     this._lruSize = value;
@@ -248,7 +263,10 @@ var CacheableMemory = class extends import_hookified.Hookified {
       return;
     }
     this._storeHashSize = value;
-    this._store = Array.from({ length: this._storeHashSize }, () => /* @__PURE__ */ new Map());
+    this._store = Array.from(
+      { length: this._storeHashSize },
+      () => /* @__PURE__ */ new Map()
+    );
   }
   /**
    * Gets the store hash algorithm
@@ -269,7 +287,7 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @returns {IterableIterator<string>} - The keys
    */
   get keys() {
-    const keys = new Array();
+    const keys = [];
     for (const store of this._store) {
       for (const key of store.keys()) {
         const item = store.get(key);
@@ -287,7 +305,7 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @returns {IterableIterator<CacheableStoreItem>} - The items
    */
   get items() {
-    const items = new Array();
+    const items = [];
     for (const store of this._store) {
       for (const item of store.values()) {
         if (this.hasExpired(item)) {
@@ -333,7 +351,7 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @returns {T[]} - The values of the keys
    */
   getMany(keys) {
-    const result = new Array();
+    const result = [];
     for (const key of keys) {
       result.push(this.get(key));
     }
@@ -363,7 +381,7 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @returns {CacheableStoreItem[]} - The raw values of the keys
    */
   getManyRaw(keys) {
-    const result = new Array();
+    const result = [];
     for (const key of keys) {
       result.push(this.getRaw(key));
     }
@@ -414,10 +432,7 @@ var CacheableMemory = class extends import_hookified.Hookified {
       }
     }
     const item = { key, value, expires };
-    store.set(
-      key,
-      item
-    );
+    store.set(key, item);
   }
   /**
    * Sets the values of the keys
@@ -444,7 +459,7 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @returns {boolean[]} - If true, the key exists. If false, the key does not exist.
    */
   hasMany(keys) {
-    const result = new Array();
+    const result = [];
     for (const key of keys) {
       const item = this.get(key);
       result.push(Boolean(item));
@@ -470,7 +485,7 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @returns {T[]} - The values of the keys
    */
   takeMany(keys) {
-    const result = new Array();
+    const result = [];
     for (const key of keys) {
       result.push(this.take(key));
     }
@@ -500,7 +515,10 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @returns {void}
    */
   clear() {
-    this._store = Array.from({ length: this._storeHashSize }, () => /* @__PURE__ */ new Map());
+    this._store = Array.from(
+      { length: this._storeHashSize },
+      () => /* @__PURE__ */ new Map()
+    );
     this._lru = new DoublyLinkedList();
   }
   /**
@@ -535,6 +553,7 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @param {any} value - The value to clone
    * @returns {any} - The cloned value
    */
+  // biome-ignore lint/suspicious/noExplicitAny: type format
   clone(value) {
     if (this.isPrimitive(value)) {
       return value;
@@ -620,14 +639,17 @@ var CacheableMemory = class extends import_hookified.Hookified {
    * @param {Object} [options] - The options to wrap
    * @returns {Function} - The wrapped function
    */
+  // biome-ignore lint/suspicious/noExplicitAny: type format
   wrap(function_, options) {
     const wrapOptions = {
       ttl: options?.ttl ?? this._ttl,
       keyPrefix: options?.keyPrefix,
+      createKey: options?.createKey,
       cache: this
     };
     return (0, import_memoize.wrapSync)(function_, wrapOptions);
   }
+  // biome-ignore lint/suspicious/noExplicitAny: type format
   isPrimitive(value) {
     const result = false;
     if (value === null || value === void 0) {

package/dist/index.d.cts

@@ -1,7 +1,7 @@
-import { Hookified } from 'hookified';
 import { WrapFunctionOptions } from '@cacheable/memoize';
 import { HashAlgorithm, CacheableStoreItem, CacheableItem } from '@cacheable/utils';
 export { CacheableItem, CacheableStoreItem, HashAlgorithm, hash, hashToNumber } from '@cacheable/utils';
+import { Hookified } from 'hookified';
 
 type StoreHashAlgorithmFunction = (key: string, storeHashSize: number) => number;
 /**

package/dist/index.d.ts

@@ -1,7 +1,7 @@
-import { Hookified } from 'hookified';
 import { WrapFunctionOptions } from '@cacheable/memoize';
 import { HashAlgorithm, CacheableStoreItem, CacheableItem } from '@cacheable/utils';
 export { CacheableItem, CacheableStoreItem, HashAlgorithm, hash, hashToNumber } from '@cacheable/utils';
+import { Hookified } from 'hookified';
 
 type StoreHashAlgorithmFunction = (key: string, storeHashSize: number) => number;
 /**

package/dist/index.js

@@ -1,15 +1,16 @@
 // src/index.ts
-import { Hookified } from "hookified";
-import { wrapSync } from "@cacheable/memoize";
 import {
-  shorthandToTime,
+  wrapSync
+} from "@cacheable/memoize";
+import {
+  HashAlgorithm,
   hashToNumber,
-  HashAlgorithm
+  shorthandToTime
 } from "@cacheable/utils";
+import { Hookified } from "hookified";
 
 // src/memory-lru.ts
 var ListNode = class {
-  // eslint-disable-next-line @typescript-eslint/parameter-properties
   value;
   prev = void 0;
   next = void 0;
@@ -93,7 +94,10 @@ var CacheableMemory = class extends Hookified {
   _storeHashSize = defaultStoreHashSize;
   _storeHashAlgorithm = HashAlgorithm.DJB2;
   // Default is djb2Hash
-  _store = Array.from({ length: this._storeHashSize }, () => /* @__PURE__ */ new Map());
+  _store = Array.from(
+    { length: this._storeHashSize },
+    () => /* @__PURE__ */ new Map()
+  );
   _ttl;
   // Turned off by default
   _useClone = true;
@@ -121,7 +125,12 @@ var CacheableMemory = class extends Hookified {
     }
     if (options?.lruSize) {
       if (options.lruSize > maximumMapSize) {
-        this.emit("error", new Error(`LRU size cannot be larger than ${maximumMapSize} due to Map limitations.`));
+        this.emit(
+          "error",
+          new Error(
+            `LRU size cannot be larger than ${maximumMapSize} due to Map limitations.`
+          )
+        );
       } else {
         this._lruSize = options.lruSize;
       }
@@ -132,7 +141,10 @@ var CacheableMemory = class extends Hookified {
     if (options?.storeHashAlgorithm) {
       this._storeHashAlgorithm = options.storeHashAlgorithm;
     }
-    this._store = Array.from({ length: this._storeHashSize }, () => /* @__PURE__ */ new Map());
+    this._store = Array.from(
+      { length: this._storeHashSize },
+      () => /* @__PURE__ */ new Map()
+    );
     this.startIntervalCheck();
   }
   /**
@@ -176,7 +188,12 @@ var CacheableMemory = class extends Hookified {
    */
   set lruSize(value) {
     if (value > maximumMapSize) {
-      this.emit("error", new Error(`LRU size cannot be larger than ${maximumMapSize} due to Map limitations.`));
+      this.emit(
+        "error",
+        new Error(
+          `LRU size cannot be larger than ${maximumMapSize} due to Map limitations.`
+        )
+      );
       return;
     }
     this._lruSize = value;
@@ -227,7 +244,10 @@ var CacheableMemory = class extends Hookified {
       return;
     }
     this._storeHashSize = value;
-    this._store = Array.from({ length: this._storeHashSize }, () => /* @__PURE__ */ new Map());
+    this._store = Array.from(
+      { length: this._storeHashSize },
+      () => /* @__PURE__ */ new Map()
+    );
   }
   /**
    * Gets the store hash algorithm
@@ -248,7 +268,7 @@ var CacheableMemory = class extends Hookified {
    * @returns {IterableIterator<string>} - The keys
    */
   get keys() {
-    const keys = new Array();
+    const keys = [];
     for (const store of this._store) {
       for (const key of store.keys()) {
         const item = store.get(key);
@@ -266,7 +286,7 @@ var CacheableMemory = class extends Hookified {
    * @returns {IterableIterator<CacheableStoreItem>} - The items
    */
   get items() {
-    const items = new Array();
+    const items = [];
     for (const store of this._store) {
       for (const item of store.values()) {
         if (this.hasExpired(item)) {
@@ -312,7 +332,7 @@ var CacheableMemory = class extends Hookified {
    * @returns {T[]} - The values of the keys
    */
   getMany(keys) {
-    const result = new Array();
+    const result = [];
     for (const key of keys) {
       result.push(this.get(key));
     }
@@ -342,7 +362,7 @@ var CacheableMemory = class extends Hookified {
    * @returns {CacheableStoreItem[]} - The raw values of the keys
    */
   getManyRaw(keys) {
-    const result = new Array();
+    const result = [];
     for (const key of keys) {
       result.push(this.getRaw(key));
     }
@@ -393,10 +413,7 @@ var CacheableMemory = class extends Hookified {
       }
     }
     const item = { key, value, expires };
-    store.set(
-      key,
-      item
-    );
+    store.set(key, item);
   }
   /**
    * Sets the values of the keys
@@ -423,7 +440,7 @@ var CacheableMemory = class extends Hookified {
    * @returns {boolean[]} - If true, the key exists. If false, the key does not exist.
    */
   hasMany(keys) {
-    const result = new Array();
+    const result = [];
     for (const key of keys) {
       const item = this.get(key);
       result.push(Boolean(item));
@@ -449,7 +466,7 @@ var CacheableMemory = class extends Hookified {
    * @returns {T[]} - The values of the keys
    */
   takeMany(keys) {
-    const result = new Array();
+    const result = [];
     for (const key of keys) {
       result.push(this.take(key));
     }
@@ -479,7 +496,10 @@ var CacheableMemory = class extends Hookified {
    * @returns {void}
    */
   clear() {
-    this._store = Array.from({ length: this._storeHashSize }, () => /* @__PURE__ */ new Map());
+    this._store = Array.from(
+      { length: this._storeHashSize },
+      () => /* @__PURE__ */ new Map()
+    );
     this._lru = new DoublyLinkedList();
   }
   /**
@@ -514,6 +534,7 @@ var CacheableMemory = class extends Hookified {
    * @param {any} value - The value to clone
    * @returns {any} - The cloned value
    */
+  // biome-ignore lint/suspicious/noExplicitAny: type format
   clone(value) {
     if (this.isPrimitive(value)) {
       return value;
@@ -599,14 +620,17 @@ var CacheableMemory = class extends Hookified {
    * @param {Object} [options] - The options to wrap
    * @returns {Function} - The wrapped function
    */
+  // biome-ignore lint/suspicious/noExplicitAny: type format
   wrap(function_, options) {
     const wrapOptions = {
       ttl: options?.ttl ?? this._ttl,
       keyPrefix: options?.keyPrefix,
+      createKey: options?.createKey,
       cache: this
     };
     return wrapSync(function_, wrapOptions);
   }
+  // biome-ignore lint/suspicious/noExplicitAny: type format
   isPrimitive(value) {
     const result = false;
     if (value === null || value === void 0) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cacheable/memory",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "High Performance In-Memory Cache for Node.js",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -21,51 +21,37 @@
   "license": "MIT",
   "private": false,
   "devDependencies": {
-    "@faker-js/faker": "^9.9.0",
-    "@keyv/redis": "^5.0.0",
-    "@keyv/valkey": "^1.0.7",
-    "@types/eslint": "^9.6.1",
-    "@types/node": "^24.1.0",
+    "@biomejs/biome": "^2.2.2",
+    "@faker-js/faker": "^10.0.0",
+    "@types/node": "^24.3.0",
     "@vitest/coverage-v8": "^3.2.4",
     "lru-cache": "^11.1.0",
     "rimraf": "^6.0.1",
     "tsup": "^8.5.0",
-    "typescript": "^5.8.3",
-    "vitest": "^3.2.4",
-    "xo": "^1.2.1"
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
   },
   "dependencies": {
     "@keyv/bigmap": "^1.0.0",
-    "hookified": "^1.10.0",
-    "keyv": "^5.4.0",
-    "@cacheable/memoize": "^1.1.0",
-    "@cacheable/utils": "^1.1.0"
+    "hookified": "^1.12.0",
+    "keyv": "^5.5.0",
+    "@cacheable/memoize": "^1.1.1",
+    "@cacheable/utils": "^1.1.1"
   },
   "keywords": [
     "cacheable",
     "high performance",
-    "layer 1 caching",
-    "layer 2 caching",
     "distributed caching",
     "Keyv storage engine",
+    "keyv",
     "memory caching",
     "LRU cache",
-    "expiration",
-    "CacheableMemory",
-    "offline support",
-    "distributed sync",
-    "secondary store",
-    "primary store",
-    "non-blocking operations",
-    "cache statistics",
-    "layered caching",
-    "fault tolerant",
+    "memory",
+    "in-memory",
     "scalable cache",
     "in-memory cache",
-    "distributed cache",
     "lruSize",
-    "lru",
-    "multi-tier cache"
+    "lru"
   ],
   "files": [
     "dist",
@@ -74,8 +60,9 @@
   "scripts": {
     "build": "rimraf ./dist && tsup src/index.ts --format cjs,esm --dts --clean",
     "prepublish": "pnpm build",
-    "test": "xo --fix && vitest run --coverage",
-    "test:ci": "xo && vitest run --coverage",
+    "lint": "biome check --write --error-on-warnings",
+    "test": "pnpm lint && vitest run --coverage",
+    "test:ci": "biome check --error-on-warnings && vitest run --coverage",
     "clean": "rimraf ./dist ./coverage ./node_modules"
   }
 }