react-query-firebase / web/firestore / useDocReference

Function: useDocReference()

function useDocReference<AppModelType>(options): null | DocumentReference<AppModelType, AppModelType>;

Defined in: web/firestore/useDocReference.ts:35

Gets a CollectionReference instance

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Parameters

options

Options

path?

string

pathSegments?

string[]

reference?

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

Returns

null | DocumentReference<AppModelType, AppModelType>

A reference to a Firestore document

Example

export const MyComponent = () => {
 const ref = useDocReference({
     reference: collection('todos')
     path: 'first'
 });
};