Skip to content

react-query-firebase / UseCollectionReferenceOptions

Type Alias: UseCollectionReferenceOptions<AppModelType> ​

ts
type UseCollectionReferenceOptions<AppModelType> = object;

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

Type Parameters ​

AppModelType ​

AppModelType extends AppModel = AppModel

Properties ​

path ​

ts
path: string;

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

A slash-separated path to a collection.


pathSegments? ​

ts
optional pathSegments?: string[];

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

Additional path segments that will be applied relative


reference? ​

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

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

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

Released under the MIT License.