API 文档 / vuefire / UseDocumentOptions
接口: UseDocumentOptions<TData>
vuefire.UseDocumentOptions
类型参数
| 名称 | 类型 |
|---|---|
TData | unknown |
层次结构
_UseFirestoreRefOptions<TData>↳
UseDocumentOptions
属性
converter
• Optional converter: FirestoreDataConverter<unknown, DocumentData>
@deprecated: 使用 .withConverter() 代替
继承自
_UseFirestoreRefOptions.converter
maxRefDepth
• Optional maxRefDepth: number
绑定嵌套引用的最大深度。未绑定的嵌套引用将保留为引用路径，而绑定的引用将包含与直接绑定引用相同的数据。
继承自
_UseFirestoreRefOptions.maxRefDepth
once
• Optional once: boolean
数据是否应该只获取一次，而不是订阅更改。
继承自
_UseFirestoreRefOptions.once
reset
• Optional reset: ResetOption
如果为 true，则在数据源解除绑定时将重置数据。传递一个函数来指定自定义重置值。
继承自
_UseFirestoreRefOptions.reset
snapshotListenOptions
• Optional snapshotListenOptions: SnapshotListenOptions
继承 Doc
继承自
_UseFirestoreRefOptions.snapshotListenOptions
snapshotOptions
• Optional snapshotOptions: SnapshotOptions
继承 Doc
继承自
_UseFirestoreRefOptions.snapshotOptions
ssrKey
• Optional ssrKey: string
用于处理 SSR 水合的可选键。**对于查询**或当同一个源在多个地方使用不同的转换器时，**是必需的**。
继承自
_UseFirestoreRefOptions.ssrKey
target
• Optional target: Ref<TData>
使用 target 引用而不是创建一个。
继承自
_UseFirestoreRefOptions.target
wait
• Optional wait: boolean
如果为 true，则在第一次设置数据之前等待数据加载完成。对于 Firestore，这包括嵌套引用。这仅对列表和集合有用。对象和文档不需要此功能。
继承自
_UseFirestoreRefOptions.wait