react-query-firebase / web/firestore / useCollectionReference

Function: useCollectionReference()

function useCollectionReference<AppModelType>(options): CollectionReference<AppModelType, AppModelType>;

Defined in: web/firestore/useCollectionReference.ts:44

Gets a CollectionReference instance that refers to a subcollection of reference at the specified relative path.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Parameters

options

Options

path

string

A slash-separated path to a collection.

pathSegments?

string[]

Additional path segments that will be applied relative

reference?

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

CollectionReference or DocumentReference that is used as a root to lookup a sub-collection

Returns

CollectionReference<AppModelType, AppModelType>

A reference to a Firestore collection

Example

export const MyComponent = () => {
 const ref = useCollectionReference({
     path: 'todos'
 });
};