docs(fix): database preset initialization

sandros94 · May 30, 2024 · cc5a493 · cc5a493
1 parent d304f4a
commit cc5a493
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -70,7 +70,11 @@ export default defineNuxtConfig({
           pass: 'root'
         }
       },
-      production: {},
+      production: {
+        host: '', // initialize any property that will be set via `.env`
+        NS: '',
+        DB: ''
+      },
     },
   },
   // ...

diff --git a/playground/nuxt.config.ts b/playground/nuxt.config.ts
@@ -5,7 +5,12 @@ export default defineNuxtConfig({
   modules: ['nuxt-surrealdb'],
   surrealdb: {
     databases: {
-      staging: {},
+      staging: {
+        host: '',
+        NS: '',
+        DB: '',
+        auth: '',
+      },
     },
   },
   devtools: { enabled: true },

diff --git a/src/module.ts b/src/module.ts
@@ -17,14 +17,13 @@ export default defineNuxtModule<ModuleOptions>({
     name: 'nuxt-surrealdb',
     configKey: 'surrealdb',
   },
-  // Default configuration options of the Nuxt module
   defaults: {
     databases: {
       default: {
         host: '',
         NS: '',
         DB: '',
-        auth: undefined,
+        auth: '',
       },
     },
     tokenCookieName: 'surrealdb_token',