Skip to content

react-query-firebase / UseGetRealtimeDocDataOptions

Type Alias: UseGetRealtimeDocDataOptions<AppModelType> ​

ts
type UseGetRealtimeDocDataOptions<AppModelType> = object;

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

Type Parameters ​

AppModelType ​

AppModelType extends AppModel = AppModel

Properties ​

onError? ​

ts
optional onError?: (error) => unknown;

Defined in: src/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? ​

ts
optional path?: string;

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

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


pathSegments? ​

ts
optional pathSegments?: string[];

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

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


reference? ​

ts
optional reference?: DocumentReference<AppModelType, AppModelType>;

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

A reference to a collection.

Released under the MIT License.