API Documentation / nuxt-vuefire / VueFireNuxtModuleOptions
Interface: VueFireNuxtModuleOptions
nuxt-vuefire.VueFireNuxtModuleOptions
Properties
admin
• Optional admin: Object
Firebase Admin Options.
Type declaration
| Name | Type | Description |
|---|---|---|
options? | Omit<AppOptions, "credential"> | Firebase Admin Options passed to firebase-admin's initializeApp(). |
appCheck
• Optional appCheck: NuxtVueFireAppCheckOptions
Enables AppCheck on the client and server. Note you only need to pass the options for the client, on the server, the configuration will be handled automatically.
auth
• Optional auth: boolean | { enabled?: boolean ; sessionCookie?: boolean | { httpOnly?: boolean ; maxAge?: number ; path: string ; sameSite: "none" | "lax" | "strict" ; secure?: boolean } } & VueFireNuxtAuthDependencies
Enables the Authentication module without the session cookie. Pass an object to enable other features.
Default Value
false
config
• Optional config: FirebaseOptions
Firebase Options passed to firebase/app's initializeApp().
emulators
• Optional emulators: boolean | { auth?: { options?: { disableWarnings: boolean } } ; enabled?: boolean ; host?: string }
Controls whether to use emulators or not. Pass false to disable emulators. When set to true, emulators are enabled when they are detected in the firebase.json file. You still need to run the emulators in parallel to your app.
Default Value
true
optionsApiPlugin
• Optional optionsApiPlugin: boolean | "firestore" | "database"
Should we add the VueFireFirestoreOptionsAPI and VueFireRealtimeDatabaseOptionsAPI modules?. Pass true to add both, or 'firestore' or 'realtime-database' to add only one. Pass false to disable.
Default Value
false