nash403 · January 14, 2025 03:29 · Jan 14, 2025 · Jan 9, 2025
diff --git a/useReactiveMap.js b/useReactiveMap.js
@@ -23,7 +23,7 @@ function useReactiveMap(initialValues, options = { shallow: true }) {
 
   const data = initMap()
 
-  Object.assign(db, { generateKey }) // add ability to standardize custom key generation
+  Object.assign(data, { generateKey }) // add ability to standardize custom key generation
 
   return data
 }
diff --git a/Readme.md b/Readme.md
@@ -0,0 +1,7 @@
+# `useReactiveMap` composable
+
+Vue 3 composable to create a reactive Map to use as a small local database. 
+
+In memory by default, users can pass a custom map object to override that behavior.
+
+The returned reactive Map is extended with ability to standardize custom key generation.
diff --git a/useReactiveMap.js b/useReactiveMap.js
@@ -0,0 +1,29 @@
+function useReactiveMap(initialValues, options = { shallow: true }) {
+  function isUsableAsMapKey(value) {
+    const type = typeof value
+    return (
+      value != null &&
+      (type === 'string' ||
+        type === 'number' ||
+        type === 'boolean' ||
+        type === 'symbol' ||
+        type === 'bigint')
+    );
+  }
+
+  const generateKey = (...args) => options?.getKey
+    ? options.getKey(...args)
+    // Default key: Serialize args
+    : args.length === 1 && isUsableAsMapKey(args[0]) ? args[0] : JSON.stringify(args)
+
+  const initMap = () => {
+    // TODO: find out how to use Proxy to extend the Map ability to directly use generateKey instead of having to call from outside this composable
+    return (options?.shallow ? shallowReactive : reactive)(options?.map ? options.map : new Map(initialValues || []))
+  }
+
+  const data = initMap()
+
+  Object.assign(db, { generateKey }) // add ability to standardize custom key generation
+
+  return data
+}