release: v3.0.0

Author: tusharf5

.eslintignore

@@ -1 +1,3 @@
 **/*.d.ts
+node_modules
+/node_modules/

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## v3.0.0
+
+### Breaking Changes
+
+- Creating a cache store now doesn't require a type for the keys. It is assumed to be a string.
+
+### Other Changes
+
+- Setting store.set on a key that already exists will also override the value.
+- Updates internal build dependencies
+
 ## v2.1.1
 
 - Remove debug statements

README.md

@@ -7,16 +7,16 @@
 <p align="center">A no dependency, <b>high performance</b>, near optimal javascript caching library</p>
 
 <p align="center">
-	<a href="https://github.com/tusharf5/runtime-memcache">
+ <a href="https://github.com/tusharf5/runtime-memcache">
      <img src="https://img.shields.io/npm/l/runtime-memcache" height="20"/>
   </a>
-	<a href="https://github.com/tusharf5/runtime-memcache">
+ <a href="https://github.com/tusharf5/runtime-memcache">
      <img src="https://img.shields.io/npm/v/runtime-memcache" height="20"/>
   </a>
-	<a href="https://github.com/tusharf5/runtime-memcache">
+ <a href="https://github.com/tusharf5/runtime-memcache">
      <img src="https://img.shields.io/npm/dt/runtime-memcache" height="20"/>
   </a>
-	<a href="https://github.com/tusharf5/runtime-memcache">
+ <a href="https://github.com/tusharf5/runtime-memcache">
      <img src="https://img.shields.io/bundlephobia/minzip/runtime-memcache" height="20"/>
   </a>
 </p><br/><br/>
@@ -126,7 +126,7 @@ type Keys = 'key1' | 'key2';
 
 const store = createStore<Keys, Response>(config);
 
-store.set('key1', { name : 'name' }); // store the object and associate it with the provided key
+store.set('key1', { name: 'name' }); // store the object and associate it with the provided key
 
 store.get('key1'); // retrieves the object associated with this key
 
@@ -142,23 +142,27 @@ store.remove('key1'); // deletes the object associated with this key
 </br>
 
 ```typescript
-import createStore from 'runtime-memcache';
+import createStore, { Config } from 'runtime-memcache';
 
-const config = {
+const config: Config = {
   policy: 'lru',
   lruSize: 300, // cache a maximum of 300 users at a given time
 };
 
-const userCache = createStore(config);
+interface User {
+  name: string;
+}
+
+const userCache = createStore<User>(config);
 
 async function loginUser(userId: string) {
-  if (userCache.has(id)) {
-    return userCache.get(id);
+  if (userCache.has(userId)) {
+    return userCache.get(userId);
   }
 
-  const user = await UserService.getUser(id);
+  const user = await UserService.getUser(userId);
 
-  userCache.set(id, user);
+  userCache.set(userId, user);
 
   return user;
 }
@@ -183,5 +187,6 @@ runtime-memcache uses a combination of modified doubly-linked lists and hashmap
 - Least Frequently Used Policy (LFU)
 - <s>Time Aware Least Recently Used Policy (TLRU)</s>
 - Random Eviction Policy (RR)
+- Add a warmup period for new items
 
 For more information on caching policies read [this](https://en.wikipedia.org/wiki/Cache_replacement_policies#LRU)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "runtime-memcache",
-  "version": "2.1.1",
+  "version": "3.0.0",
   "description": "A no dependency javascript runtime key-value cache store for small chunks of arbitrary data (strings, objects, numbers)",
   "homepage": "https://github.com/tusharf5/runtime-memcache",
   "main": "./dist/umd/index.js",
@@ -42,28 +42,28 @@
     "mru"
   ],
   "devDependencies": {
-    "@types/jest": "^26.0.0",
-    "@types/node": "^14.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.0.0",
-    "@typescript-eslint/parser": "^4.0.0",
-    "babel-loader": "^8.0.0",
-    "copy-webpack-plugin": "^5.0.0",
-    "eslint": "^6.0.0",
-    "eslint-config-airbnb": "^18.0.0",
-    "eslint-config-prettier": "^6.0.0",
-    "eslint-config-typescript": "^3.0.0",
-    "eslint-formatter-pretty": "^3.0.0",
-    "eslint-import-resolver-typescript": "^2.0.0",
-    "eslint-loader": "^4.0.0",
-    "eslint-plugin-import": "^2.0.0",
-    "eslint-plugin-prettier": "^3.0.0",
-    "eslint-plugin-typescript": "^0.14.0",
-    "jest": "^26.0.0",
-    "prettier": "^2.0.0",
-    "ts-node": "^8.0.0",
-    "typescript": "^3.0.0",
-    "typescript-eslint-parser": "^22.0.0",
-    "webpack": "^4.0.0",
-    "webpack-cli": "^3.0.0"
+    "@types/jest": "~28.1.0",
+    "@types/node": "^16.0.0",
+    "@typescript-eslint/eslint-plugin": "~5.30.0",
+    "@typescript-eslint/parser": "~5.30.0",
+    "babel-loader": "~8.2.0",
+    "copy-webpack-plugin": "11.0.0",
+    "eslint": "~8.20.0",
+    "eslint-config-airbnb": "~19.0.0",
+    "eslint-config-prettier": "~8.5.0",
+    "eslint-config-typescript": "~3.0.0",
+    "eslint-formatter-pretty": "~4.1.0",
+    "eslint-import-resolver-typescript": "~3.2.0",
+    "eslint-loader": "~4.0.0",
+    "eslint-plugin-import": "~2.26.0",
+    "eslint-plugin-prettier": "~4.2.0",
+    "eslint-plugin-typescript": "~0.14.0",
+    "jest": "~28.1.0",
+    "prettier": "~2.7.0",
+    "ts-node": "~10.9.0",
+    "typescript": "~4.6.2",
+    "typescript-eslint-parser": "~22.0.0",
+    "webpack": "~5.73.0",
+    "webpack-cli": "~4.10.0"
   }
 }

src/lru-store.ts

@@ -1,35 +1,35 @@
 import { Cache, GlobalConfig } from './types';
 import { LRULinkedList } from './utils/LRULinkedList';
 
-function createStore<K, V>(config: Required<GlobalConfig>): Cache<K, V> {
-  const store = new LRULinkedList<K, V>(config);
+function createStore<V>(config: Required<GlobalConfig>): Cache<V> {
+  const store = new LRULinkedList<V>(config);
 
-  function get(key: K) {
+  function get(key: string): V {
     const val = store.get(key);
     if (val) {
       return val;
     }
     return null;
   }
 
-  function remove(key: K) {
+  function remove(key: string) {
     store.remove(key);
     return true;
   }
 
-  function has(key: K) {
+  function has(key: string) {
     return store.has(key);
   }
 
   function size(): number {
     return store.size;
   }
 
-  function keys(): K[] {
+  function keys(): string[] {
     return store.keys();
   }
 
-  function set(key: K, value: any) {
+  function set(key: string, value: V) {
     store.addNodeToHead(key, value);
     return true;
   }

src/mru-store.ts

@@ -1,35 +1,35 @@
 import { Cache, GlobalConfig } from './types';
 import { MRULinkedList } from './utils/MRULinkedList';
 
-function createStore<K, V>(config: Required<GlobalConfig>): Cache<K, V> {
-  const store = new MRULinkedList<K, V>(config);
+function createStore<V>(config: Required<GlobalConfig>): Cache<V> {
+  const store = new MRULinkedList<V>(config);
 
-  function get(key: K) {
+  function get(key: string): V {
     const val = store.get(key);
     if (val) {
       return val;
     }
     return null;
   }
 
-  function remove(key: K) {
+  function remove(key: string) {
     store.remove(key);
     return true;
   }
 
-  function has(key: K) {
+  function has(key: string) {
     return store.has(key);
   }
 
   function size(): number {
     return store.size;
   }
 
-  function keys(): K[] {
+  function keys(): string[] {
     return store.keys();
   }
 
-  function set(key: K, value: any) {
+  function set(key: string, value: V) {
     store.addNodeToHead(key, value);
     return true;
   }

src/store.ts

@@ -13,7 +13,7 @@ export const defaultConfig: Required<GlobalConfig> = {
   mruSize: 500,
 };
 
-function createStore<K extends string, V = any>(userConfig?: Config): Cache<K, V> {
+function createStore<V = any>(userConfig?: Config): Cache<V> {
   let userConfigVerf: Config = {};
   if (typeof userConfig === 'object') {
     userConfigVerf = userConfig;
@@ -23,13 +23,13 @@ function createStore<K extends string, V = any>(userConfig?: Config): Cache<K, V
 
   switch (config.policy) {
     case 'timeout':
-      return createTimeoutStore<K, V>(config);
+      return createTimeoutStore<V>(config);
     case 'lru':
-      return createLruStore<K, V>(config);
+      return createLruStore<V>(config);
     case 'mru':
-      return createMruStore<K, V>(config);
+      return createMruStore<V>(config);
     case 'tlru':
-      return createTLruStore<K, V>(config);
+      return createTLruStore<V>(config);
     default:
       throw new Error(config.policy + ' is not a supported policy.');
   }

src/timeout-store.ts

@@ -2,18 +2,18 @@ import { Cache, GlobalConfig } from './types';
 
 import { createTimeAwareMapObserver } from './utils/TimeAwareMap';
 
-function createStore<K, V>(config: GlobalConfig): Cache<K, V> {
-  const store = new Map<K, any>();
-  const timer = createTimeAwareMapObserver<K>(config.timeToClear);
-  function get(key: K) {
+function createStore<V>(config: GlobalConfig): Cache<V> {
+  const store = new Map<string, any>();
+  const timer = createTimeAwareMapObserver(config.timeToClear);
+  function get(key: string): V {
     const val = store.get(key);
     if (val) {
       return val;
     }
     return null;
   }
 
-  function remove(key: K) {
+  function remove(key: string) {
     store.delete(key);
     timer.cancel(key);
     return true;
@@ -23,15 +23,15 @@ function createStore<K, V>(config: GlobalConfig): Cache<K, V> {
     return store.size;
   }
 
-  function has(key: K): boolean {
+  function has(key: string): boolean {
     return store.has(key);
   }
 
-  function keys(): K[] {
+  function keys(): string[] {
     return Array.from(store.keys());
   }
 
-  function set(key: K, value: V) {
+  function set(key: string, value: V) {
     store.set(key, value);
     timer.create(key, remove);
     return true;

src/tlru-store.ts

@@ -1,35 +1,35 @@
 import { Cache, GlobalConfig } from './types';
 import { TLRULinkedList } from './utils/TLRULinkedList';
 
-function createStore<K, V>(config: Required<GlobalConfig>): Cache<K, V> {
-  const store = new TLRULinkedList<K, V>(config);
+function createStore<V>(config: Required<GlobalConfig>): Cache<V> {
+  const store = new TLRULinkedList<V>(config);
 
-  function get(key: K) {
+  function get(key: string): V {
     const val = store.get(key);
     if (val) {
       return val;
     }
     return null;
   }
 
-  function remove(key: K) {
+  function remove(key: string) {
     store.remove(key);
     return true;
   }
 
-  function has(key: K) {
+  function has(key: string) {
     return store.has(key);
   }
 
   function size(): number {
     return store.size;
   }
 
-  function keys(): K[] {
+  function keys(): string[] {
     return store.keys();
   }
 
-  function set(key: K, value: any) {
+  function set(key: string, value: V) {
     store.addNodeToHead(key, value);
     return true;
   }

src/types.ts

@@ -6,18 +6,18 @@ export interface Config {
   mruSize?: number;
 }
 
-export interface CreateTimeoutResult<K> {
-  create(key: K, removeFromStore: (key: K) => any): void;
-  cancel(key: K): void;
+export interface CreateTimeoutResult {
+  create(key: string, removeFromStore: (key: string) => any): void;
+  cancel(key: string): void;
 }
 
-export interface Cache<K, V> {
-  keys(): K[];
+export interface Cache<V = any> {
+  keys(): string[];
   size(): number;
-  has(key: K): boolean;
-  get(key: K): V | null;
-  set(key: K, value: V): void;
-  remove(key: K): void;
+  has(key: string): boolean;
+  get(key: string): V | null;
+  set(key: string, value: V): void;
+  remove(key: string): void;
 }
 
 export interface GlobalConfig extends Config {}