react-query-firebase / web/firestore / UseCollectionReferenceOptions

Type Alias: UseCollectionReferenceOptions<AppModelType>

type UseCollectionReferenceOptions<AppModelType> = object;

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

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel

Properties

path

path: string;

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

A slash-separated path to a collection.

---

pathSegments?

optional pathSegments: string[];

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

Additional path segments that will be applied relative

---

reference?

optional reference: 
  | CollectionReference<AppModelType, AppModelType>
| DocumentReference<AppModelType, AppModelType>;

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

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