worker module docs

DeFUCC · Apr 27, 2023 · e5c7344 · e5c7344
1 parent c167c6c
commit e5c7344
Showing 1 changed file with 8 additions and 1 deletion.
diff --git a/src/gun/useGunWorker.ts b/src/gun/useGunWorker.ts
@@ -1,11 +1,18 @@
+/**
+ * Gun DB to be used as an inlined Web Worker
+ * @module GunWorker
+ * @group Database
+ */
+
+
 //@ts-ignore
 import worker from './worker.js?worker&inline'
 import { useWebWorker } from '@vueuse/core'
 import { watch } from 'vue'
 
 const GunWorker = useWebWorker(worker)
 
-GunWorker.post('Worker check up')
+GunWorker.post('Worker post check up')
 
 watch(GunWorker.data, d => console.log('Recieved:', d), { immediate: true })