react-query-firebase / react-native/firestore / useDocReference

Function: useDocReference()

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

Defined in: react-native/firestore/useDocReference.ts:35

Gets a CollectionReference instance.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Parameters

options

UseDocReferenceOptions<AppModelType>

Options

Returns

DocumentReference<AppModelType> | null

A reference to a Firestore document

Example

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