mentie 0.3.0 → 0.3.2

package/modules/cache.js

@@ -13,7 +13,7 @@ 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.
  */
@@ -30,10 +30,13 @@ export function cache( key, value, expires_in_ms=Infinity ) {
     }
 
     // If value is provided, save value and expiration
-    if( value ) _cache[key] = { value, expires: Date.now() + expires_in_ms }
+    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() ) delete _cache[key]
+    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/modules/text.js

@@ -1,3 +1,5 @@
+import { random_number_between } from "./numbers"
+
 /**
  * Truncates a given text to a specified length and appends a suffix if necessary.
  *
@@ -38,3 +40,30 @@ export const capitalise = string => {
     if( !string ) return ''
     return `${ string?.charAt( 0 ).toUpperCase() }${ string?.slice( 1, string?.length ) }`
 }
+
+
+/**
+ * Generates a random letter from the allowed characters.
+ *
+ * @param {string} [allowed_chars] - A string of characters to choose from. If not provided, defaults to the lowercase English alphabet.
+ * @returns {string} A randomly selected character from the allowed characters.
+ */
+export const random_letter = ( allowed_chars, capitals=true ) => {
+
+    const letters = 'abcdefghijklmnopqrstuvwxyz'
+    let chars = allowed_chars || letters
+    if( capitals ) chars += letters.toUpperCase()
+
+    return chars.charAt( Math.floor( Math.random() * chars.length ) )
+
+}
+
+export const random_string_of_length = ( length, allowed_chars, numbers=true ) => {
+
+    return Array.from( { length }, () => {
+        // If numbers are allowed, add a 50% chance of generating a number
+        if( numbers && Math.random() > 0.5 ) return `${ random_number_between( 9, 0 ) }`
+        return random_letter( allowed_chars )
+    } ).join( '' )
+
+}

package/package.json

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