API 文档 / vuefire / FirestorePluginOptions
接口: FirestorePluginOptions
vuefire.FirestorePluginOptions
Firebase 数据库插件的选项，它启用了选项 API，例如 $firestoreBind 和 $firestoreUnbind。
层次结构
FirestoreRefOptions↳
FirestorePluginOptions
属性
bindName
• Optional bindName: string
@deprecated: 基本上没有使用，而且不太有用。如果您需要此功能，请打开一个问题并提供用例。
converter
• Optional converter: FirestoreDataConverter<unknown, DocumentData>
与快照一起使用的默认 Firestore 转换器。
继承自
FirestoreRefOptions.converter
maxRefDepth
• Optional maxRefDepth: number
绑定嵌套引用的最大深度。未绑定的嵌套引用将保留为引用路径，而绑定的引用将包含与直接绑定引用相同的数据。
继承自
FirestoreRefOptions.maxRefDepth
once
• Optional once: boolean
是否应该获取一次数据，而不是订阅更改。
继承自
FirestoreRefOptions.once
reset
• Optional reset: ResetOption
如果为 true，则在数据源解除绑定时将重置数据。传递一个函数来指定自定义重置值。
继承自
FirestoreRefOptions.reset
snapshotListenOptions
• Optional snapshotListenOptions: SnapshotListenOptions
继承 Doc
继承自
FirestoreRefOptions.snapshotListenOptions
snapshotOptions
• Optional snapshotOptions: SnapshotOptions
继承 Doc
继承自
FirestoreRefOptions.snapshotOptions
ssrKey
• Optional ssrKey: string
用于处理 SSR 水合的可选键。对于查询或当同一个源在多个地方使用不同的转换器时，这是必需的。
继承自
FirestoreRefOptions.ssrKey
target
• Optional target: Ref<unknown>
使用 target 引用而不是创建一个。
继承自
FirestoreRefOptions.target
unbindName
• Optional unbindName: string
@deprecated: 基本上没有使用，而且不太有用。如果您需要此功能，请打开一个问题并提供用例。
wait
• Optional wait: boolean
如果为 true，则在首次设置数据之前等待数据加载完成。对于 Firestore，这包括嵌套引用。这仅对列表和集合有用。对象和文档不需要此功能。
继承自
FirestoreRefOptions.wait