mentie 0.2.38 → 0.3.1

package/README.md

@@ -2,3 +2,8 @@
 
 Mentor's favorite helpers.
 
+## Logging
+
+Cross environment logging depends on the `LOGLEVEL` variable. In web it is set with `?loglevel=`, in others with an environment variable `LOGLEVEL`.
+
+Valid values: `info`, `warn`, `error`.

package/modules/cache.js

@@ -13,10 +13,11 @@ const _cache = {}
  * If no value is provided, it retrieves the value from the cache.
  *
  * @param {string} key - The key to cache the value.
- * @param {*} [value] - The value to be cached (optional).
+ * @param {*} [value] - The value to be cached (optional). Use null to unset, undefined is never saved when provided as a parameter
+ * @param {number} [expires_in_ms=Infinity] - The expiration time in milliseconds (optional).
  * @returns {*} The cached value.
  */
-export function cache( key, value ) {
+export function cache( key, value, expires_in_ms=Infinity ) {
 
     // If the key is undefined, log a warning
     if( key === undefined ) {
@@ -28,8 +29,17 @@ export function cache( key, value ) {
         log.warn( `The cache key ${ key } contains 'undefined', this may indicate a bug in your cache logic` )
     }
 
-    if( value ) _cache[key] = value
-    return _cache[key]
+    // If value is provided, save value and expiration
+    if( value !== undefined ) _cache[key] = { value, expires: Date.now() + expires_in_ms }
+
+    // If cache has value, but it expired, remove it
+    if( _cache[key] && _cache[key].expires < Date.now() ) {
+        log.info( `Cache key ${ key } expired, removing from cache` )
+        delete _cache[key]
+    }
+    
+    // Return the value of the cache key, which may be undefined
+    return _cache[key]?.value
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mentie",
-  "version": "0.2.38",
+  "version": "0.3.1",
   "description": "Mentor's toolbelt",
   "type": "module",
   "main": "index.js",