Debugged and tested locally.

Author: skrenek

.gitignore

@@ -12,3 +12,4 @@ dist
 yarn.lock
 shrinkwrap.yaml
 package-lock.json
+pkg-local

README.md

@@ -43,7 +43,7 @@ Parameters
 * connectionName - Ignored if storage is not 'redis'.  The configured Redis connection name to utilize for the cache.
 
 #### CacheManager.createTLRUCache
-Creates a timed LRU (TLRU) cache.
+Creates a timed LRU (TLRU) cache.  Note that the timeout is a max possible time a cached item can live, not since its last access.
 
 Parameters
 * key - the key used to retrieve the cache later
@@ -129,7 +129,7 @@ export default class AppProvider {
 Below is an example output of health check metadata info for a user cache.  It is not recommended to configure the cache to include items if the cache size is large, as the health check data could become quite large.
 
 ```json
-"userCache": {
+{
   "displayName": "User Cache",
   "message": "Size 1 of 50",
   "meta": {

index.ts

@@ -8,5 +8,7 @@
 */
 
 export { configure } from './configure.js'
-export { CacheItem } from './src/cache.js'
+export { type CacheEngineType, CacheItem } from './src/cache.js'
 export { CacheHealthCheck } from './src/health_check.js'
+export { LRUCache } from './src/lru_cache.js'
+export { TLRUCache } from './src/tlru_cache.js'

package.json

@@ -5,9 +5,14 @@
   "engines": {
     "node": ">=20.6.0"
   },
+  "main": "build/index.js",
   "type": "module",
   "files": [
-    "build/src",
+    "!build/bin",
+    "!build/tests",
+    "build/configure.js",
+    "build/configure.d.ts",
+    "build/src/**/*",
     "build/providers",
     "build/stubs",
     "build/index.d.ts",
@@ -33,7 +38,8 @@
     "postbuild": "npm run copy:templates",
     "release": "np",
     "version": "npm run build",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "publish:local": "del pkg-local/*.tgz && npm run build && npm pack --pack-destination ./pkg-local"
   },
   "devDependencies": {
     "@adonisjs/assembler": "^7.7.0",
@@ -56,11 +62,11 @@
     "typescript": "~5.4.5"
   },
   "dependencies": {
-    "@adonisjs/redis": "^9.1.0",
     "luxon": "^3.4.4"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.2.0"
+    "@adonisjs/core": "^6.2.0",
+    "@adonisjs/redis": "^9.1.0"
   },
   "author": "Zeytech Inc (https://zeytech.com)",
   "license": "MIT",

src/health_check.ts

@@ -61,6 +61,8 @@ export class CacheHealthCheck extends BaseCheck {
         })
       }
     }
-    return Result.ok(`${meta.length} caches reporting statistics`).mergeMetaData(meta)
+    return Result.ok(
+      `${meta.length} of ${cacheKeys.length} caches reporting statistics`
+    ).setMetaData(meta)
   }
 }

src/lru_cache.ts

@@ -135,6 +135,6 @@ export class LRUCache<T> {
   }
 
   get displayName(): string {
-    return this.displayName
+    return this._displayName
   }
 }

tsconfig.json

@@ -2,6 +2,6 @@
   "extends": "@adonisjs/tsconfig/tsconfig.package.json",
   "compilerOptions": {
     "rootDir": "./",
-    "outDir": "./build",
+    "outDir": "./build"
   }
 }