react-query-firebase / firestore / useGetRealtimeDocData

Function: useGetRealtimeDocData()

function useGetRealtimeDocData<AppModelType, DbModelType>(options): object

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

A hook to get realtime updates to a firestore document.

Type Parameters

• AppModelType

• DbModelType extends DocumentData = DocumentData

Parameters

options

onError?

(error) => unknown

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

path?

string

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

pathSegments?

string[]

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

reference?

| CollectionReference<AppModelType, DbModelType> | DocumentReference<AppModelType, DbModelType>

A reference to a collection.

Returns

object

data

data: null | AppModelType;

error

error: null | FirebaseError;

isError

isError: boolean;

isFetching

isFetching: boolean;

Example

const firebaseConfig = {};
export const MyComponent = () => {
 const result = useGetRealtimeDocData('collection/documentId');
 return (
     <div>
         {JSON.stringify(result)}
     </div>
 );
};