feat(infra,docs): update libs directory and TSC config, add general i…

…nfo to readme

README.md

@@ -37,4 +37,11 @@ If in general it's usually true, this is very subjective if applied to implement
 
 ## General Theory
 
-When the cache becomes full, a cache block or record/entry must be evicted to make room for a new block. The replacement policy determines which block to evict.
+When the cache becomes full, a cache block or record/entry must be evicted to make room for a new block. The replacement policy determines which block to evict.
+
+Various cache implementations can have slightly different public APIs, however most of them are very consistent in their core capabilities. In the list below there are typical extra features (or just their naming) which can be found in known realisations:
+
+| Member | Type | Description                                                                         |
+|--------|------|-------------------------------------------------------------------------------------|
+|`setpop`|method|Sets a value for the given key, but besides that returns evicted object or old value.|
+|`peek`  |method|Retrieves the value associated with the given key, doesn't update access information.|

libs/decorators.ts → libs/decorators/detect-one-hit-wonder.ts

@@ -1,8 +1,3 @@
-/**
- * Cache method decorators.
- * Designed to be used to extend cache capabilities.
- */
-
 /**
  * Detect one-hit-wonder objects.
  */
@@ -31,17 +26,5 @@ const detectOneHitWonder = (() => {
     }
 })();
 
-function log() {
-    return function (originalMethod: any, _context: ClassMethodDecoratorContext) {
-        function replacementMethod(this: any, key: any, value: any) {
-            // @todo: implement
-        }
-
-        return replacementMethod;
-    };
-}
-
 
-export {
-    detectOneHitWonder
-};
+export default detectOneHitWonder;

libs/decorators/log.ts

@@ -0,0 +1,15 @@
+/**
+ * Add logging for cache operations.
+ */
+function log() {
+    return function (originalMethod: any, _context: ClassMethodDecoratorContext) {
+        function replacementMethod(this: any, key: any, value: any) {
+            // @todo: implement
+        }
+
+        return replacementMethod;
+    };
+}
+
+
+export default log;

rr-cache/index.ts

@@ -1,4 +1,4 @@
-import { TConfigOptions, ICache } from '../libs/types.js';
+import { ICache } from '../libs/types.js';
 
 class RRCache implements ICache {
     #hits: number;
@@ -9,9 +9,7 @@ class RRCache implements ICache {
     #freeSlots: Array<number>;
     #store;
 
-    constructor ( options: TConfigOptions ) {
-        const { capacity } = options;
-
+    constructor ( capacity: number ) {
         if (!Number.isInteger(capacity) || capacity <= 0) throw new Error('invalid "capacity": positive integer expected');
 
         this.#hits = 0;

tsconfig.json

@@ -14,6 +14,7 @@
     "*/index.ts"
   ],
   "exclude": [
-    "node_modules"
+    "node_modules",
+    "libs"
   ]
 }