Skip to content

react-query-firebase / useDocReference

Function: useDocReference() ​

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

Defined in: src/web/firestore/useDocReference.ts:33

Gets a CollectionReference instance

Type Parameters ​

AppModelType ​

AppModelType extends AppModel = AppModel

Parameters ​

options ​

UseDocReferenceOptions<AppModelType>

Options

Returns ​

DocumentReference<AppModelType, AppModelType> | null

A reference to a Firestore document

Example ​

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

Released under the MIT License.