react-query-firebase / web/firestore / UseGetRealtimeDocDataOptions

Type Alias: UseGetRealtimeDocDataOptions<AppModelType>

type UseGetRealtimeDocDataOptions<AppModelType> = object;

Defined in: web/firestore/useGetRealtimeDocData.ts:11

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Properties

onError()?

optional onError: (error) => unknown;

Defined in: web/firestore/useGetRealtimeDocData.ts:29

A callback to be called if the listen fails or is cancelled. No further callbacks will occur.

Parameters

error

FirebaseError

Returns

unknown

---

path?

optional path: string;

Defined in: web/firestore/useGetRealtimeDocData.ts:15

A slash-separated path to a document. Has to be omitted to use

---

pathSegments?

optional pathSegments: string[];

Defined in: web/firestore/useGetRealtimeDocData.ts:24

Additional path segments that will be applied relative to the first argument.

---

reference?

optional reference: DocumentReference<AppModelType, AppModelType>;

Defined in: web/firestore/useGetRealtimeDocData.ts:19

A reference to a collection.