react-query-firebase / firestore / UseGetRealtimeDocDataOptions

Type Alias: UseGetRealtimeDocDataOptions<AppModelType, DbModelType>

type UseGetRealtimeDocDataOptions<AppModelType, DbModelType> = object;

Defined in: src/firestore/useGetRealtimeDocData.ts:10

Type Parameters

• AppModelType

• DbModelType extends DocumentData = DocumentData

Type declaration

onError()?

optional onError: (error) => unknown;

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;

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

pathSegments?

optional pathSegments: string[];

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

reference?

optional reference: 
  | CollectionReference<AppModelType, DbModelType>
| DocumentReference<AppModelType, DbModelType>;

A reference to a collection.