simple-in-memory-cache 0.2.0 → 0.3.0

package/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.3.0](https://www.github.com/ehmpathy/simple-in-memory-cache/compare/v0.2.1...v0.3.0) (2022-11-24)
+
+
+### Features
+
+* **keys:** enable accurate retrieval of all valid cache keys ([5a70816](https://www.github.com/ehmpathy/simple-in-memory-cache/commit/5a708160850be4460f421ef39573ea54da17fbb2))
+
+### [0.2.1](https://www.github.com/ehmpathy/simple-in-memory-cache/compare/v0.2.0...v0.2.1) (2022-11-23)
+
+
+### Bug Fixes
+
+* **cicd:** add test:format script to unblock ghactions ([f4f645c](https://www.github.com/ehmpathy/simple-in-memory-cache/commit/f4f645ce6ec9d44ea44a2f175f5fbcdddbacd45f))
+
 ## [0.2.0](https://www.github.com/ehmpathy/simple-in-memory-cache/compare/v0.1.0...v0.2.0) (2022-11-23)
 
 

package/dist/cache.d.ts

@@ -3,6 +3,7 @@ export interface SimpleInMemoryCache<T> {
     set: (key: string, value: T, options?: {
         secondsUntilExpiration?: number;
     }) => void;
+    keys: () => string[];
 }
 export interface SimpleInMemoryCacheState<T> {
     [index: string]: {

package/dist/cache.js

@@ -7,6 +7,12 @@ exports.createCache = ({ defaultSecondsUntilExpiration = 5 * 60 } = {}) => {
     const cache = {};
     // define how to set an item into the cache
     const set = (key, value, { secondsUntilExpiration = defaultSecondsUntilExpiration } = {}) => {
+        // handle cache invalidation
+        if (value === undefined) {
+            delete cache[key];
+            return;
+        }
+        // handle setting
         const expiresAtMse = getMseNow() + secondsUntilExpiration * 1000;
         cache[key] = { value, expiresAtMse };
     };
@@ -19,7 +25,11 @@ exports.createCache = ({ defaultSecondsUntilExpiration = 5 * 60 } = {}) => {
             return undefined; // if already expired, then undefined
         return cacheContent.value; // otherwise, its in the cache and not expired, so return the value
     };
+    // define how to grab all valid keys
+    const keys = () => Object.entries(cache)
+        .filter(([_, value]) => value.expiresAtMse > getMseNow())
+        .map(([key]) => key);
     // return the api
-    return { set, get };
+    return { set, get, keys };
 };
 //# sourceMappingURL=cache.js.map

package/dist/cache.js.map

@@ -1 +1 @@
-{"version":3,"file":"cache.js","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":";;;AASA,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;AAEhC,QAAA,WAAW,GAAG,CAAI,EAAE,6BAA6B,GAAG,CAAC,GAAG,EAAE,KAAiD,EAAE,EAExH,EAAE;IACF,4CAA4C;IAC5C,MAAM,KAAK,GAAgC,EAAE,CAAC;IAE9C,2CAA2C;IAC3C,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,KAAQ,EAAE,EAAE,sBAAsB,GAAG,6BAA6B,KAA0C,EAAE,EAAE,EAAE;QAC1I,MAAM,YAAY,GAAG,SAAS,EAAE,GAAG,sBAAsB,GAAG,IAAI,CAAC;QACjE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IACvC,CAAC,CAAC;IAEF,2CAA2C;IAC3C,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,EAAE;QAC1B,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,YAAY;YAAE,OAAO,SAAS,CAAC,CAAC,kCAAkC;QACvE,IAAI,YAAY,CAAC,YAAY,GAAG,SAAS,EAAE;YAAE,OAAO,SAAS,CAAC,CAAC,qCAAqC;QACpG,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,mEAAmE;IAChG,CAAC,CAAC;IAEF,iBAAiB;IACjB,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACtB,CAAC,CAAC"}
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":";;;AAUA,MAAM,SAAS,GAAG,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;AAEhC,QAAA,WAAW,GAAG,CAAI,EAAE,6BAA6B,GAAG,CAAC,GAAG,EAAE,KAAiD,EAAE,EAExH,EAAE;IACF,4CAA4C;IAC5C,MAAM,KAAK,GAAgC,EAAE,CAAC;IAE9C,2CAA2C;IAC3C,MAAM,GAAG,GAAG,CACV,GAAW,EACX,KAAoB,EACpB,EAAE,sBAAsB,GAAG,6BAA6B,KAA0C,EAAE,EACpG,EAAE;QACF,4BAA4B;QAC5B,IAAI,KAAK,KAAK,SAAS,EAAE;YACvB,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC;YAClB,OAAO;SACR;QAED,iBAAiB;QACjB,MAAM,YAAY,GAAG,SAAS,EAAE,GAAG,sBAAsB,GAAG,IAAI,CAAC;QACjE,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IACvC,CAAC,CAAC;IAEF,2CAA2C;IAC3C,MAAM,GAAG,GAAG,CAAC,GAAW,EAAE,EAAE;QAC1B,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;QAChC,IAAI,CAAC,YAAY;YAAE,OAAO,SAAS,CAAC,CAAC,kCAAkC;QACvE,IAAI,YAAY,CAAC,YAAY,GAAG,SAAS,EAAE;YAAE,OAAO,SAAS,CAAC,CAAC,qCAAqC;QACpG,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC,mEAAmE;IAChG,CAAC,CAAC;IAEF,oCAAoC;IACpC,MAAM,IAAI,GAAG,GAAG,EAAE,CAChB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;SAClB,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,YAAY,GAAG,SAAS,EAAE,CAAC;SACxD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAEzB,iBAAiB;IACjB,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC;AAC5B,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-in-memory-cache",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "A simple in-memory cache, for nodejs and the browser, with time based expiration policies.",
   "author": "UladKasach @uladkasach",
   "license": "MIT",
@@ -33,6 +33,7 @@
     "build:ts": "tsc -p ./tsconfig.build.json",
     "build": "npm run build:clean && npm run build:ts",
     "test:types": "tsc --noEmit",
+    "test:format": "prettier --parser typescript --check 'src/**/*.ts' --config ./prettier.config.js",
     "test:lint": "eslint -c ./.eslintrc.js src/**/*.ts",
     "test:unit": "jest --forceExit --verbose --passWithNoTests",
     "test:integration": "jest -c ./jest.integration.config.js --forceExit --verbose --passWithNoTests",