react-query-firebase / web/firestore / useGetDocData

Function: useGetDocData()

function useGetDocData<AppModelType>(options): UseQueryResult<AppModelType, Error>;

Defined in: web/firestore/useGetDocData.ts:40

Executes a query on a Firestore data source and returns the resulting document.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Parameters

options

object & Omit<{ db: Firestore; path?: string; pathSegments?: string[]; reference?: | CollectionReference<AppModelType, AppModelType> | DocumentReference<AppModelType, AppModelType>; }, "db">

Configuration options for the query.

Returns

UseQueryResult<AppModelType, Error>

An object containing document's data

Example

export const MyComponent = () => {
 const doc = useGetDocData({
     options: {
         queryKey: ['key']
     },
     reference: collection(),
     path: 'id'
 });
 console.log(doc);
};