API Documentation / vuefire / DatabasePluginOptions
Interface: DatabasePluginOptions
vuefire.DatabasePluginOptions
Options for the Firebase Database Plugin that enables the Options API such as $databaseBind and $databaseUnbind.
Hierarchy
_DatabaseRefOptions↳
DatabasePluginOptions
Properties
bindName
• Optional bindName: string
@deprecated: was largely unused and not very useful. Please open an issue with use cases if you need this.
once
• Optional once: boolean
Should the data be fetched once rather than subscribing to changes.
Inherited from
_DatabaseRefOptions.once
reset
• Optional reset: ResetOption
If true, the data will be reset when the data source is unbound. Pass a function to specify a custom reset value.
Inherited from
_DatabaseRefOptions.reset
serialize
• Optional serialize: DatabaseSnapshotSerializer<unknown>
Function to transform snapshots into data. Make sure to reuse the original serializer to add the object id. See https://vuefire.vuejs.org/guide/global-options.html
Inherited from
_DatabaseRefOptions.serialize
ssrKey
• Optional ssrKey: string
Optional key to handle SSR hydration. Necessary for Queries or when the same source is used in multiple places with different converters.
Inherited from
_DatabaseRefOptions.ssrKey
target
• Optional target: Ref<unknown, unknown>
Use the target ref instead of creating one.
Inherited from
_DatabaseRefOptions.target
unbindName
• Optional unbindName: string
@deprecated: was largely unused and not very useful. Please open an issue with use cases if you need this.
wait
• Optional wait: boolean
If true, wait until the data is loaded before setting the data for the first time. For Firestore, this includes nested refs. This is only useful for lists and collections. Objects and documents do not need this.
Inherited from
_DatabaseRefOptions.wait