Skip to content
On this page

API Documentation / UseDocumentOptions

Interface: UseDocumentOptions

Hierarchy

  • _UseFirestoreRefOptions

    UseDocumentOptions

Properties

converter

Optional converter: any

@deprecated: use .withConverter() instead

Inherited from

_UseFirestoreRefOptions.converter


maxRefDepth

Optional maxRefDepth: number

The maximum depth to bind nested refs. A nested ref that isn't bound will stay as the ref path while a bound ref will contain the same data as if the ref was bound directly.

Inherited from

_UseFirestoreRefOptions.maxRefDepth


once

Optional once: boolean

Should the data be fetched once rather than subscribing to changes. Still under development

Inherited from

_UseFirestoreRefOptions.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

_UseFirestoreRefOptions.reset


snapshotListenOptions

Optional snapshotListenOptions: SnapshotListenOptions

Inherit Doc

Inherited from

_UseFirestoreRefOptions.snapshotListenOptions


snapshotOptions

Optional snapshotOptions: SnapshotOptions

Inherit Doc

Inherited from

_UseFirestoreRefOptions.snapshotOptions


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

_UseFirestoreRefOptions.ssrKey


target

Optional target: Ref<unknown>

Use the target ref instead of creating one.

Inherited from

_UseFirestoreRefOptions.target


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

_UseFirestoreRefOptions.wait

Released under the MIT License.