Add support for Firestore snapshotOptions. Closes #78

Author: chrisbianca

firestore/README.md

@@ -71,7 +71,7 @@ const FirestoreCollection = () => {
         {value && (
           <span>
             Collection:{' '}
-            {value.docs.map(doc => (
+            {value.docs.map((doc) => (
               <React.Fragment key={doc.id}>
                 {JSON.stringify(doc.data())},{' '}
               </React.Fragment>
@@ -107,7 +107,7 @@ Returns:
 ### useCollectionData
 
 ```js
-const [values, loading, error] = useCollectionData<T>(query, options);
+const [values, loading, error] = useCollectionData < T > (query, options);
 ```
 
 As `useCollection`, but this hook extracts a typed list of the `firebase.firestore.QuerySnapshot.docs` values, rather than the
@@ -120,6 +120,7 @@ The `useCollectionData` hook takes the following parameters:
   - `idField`: (optional) name of the field that should be populated with the `firebase.firestore.QuerySnapshot.id` property.
   - `refField`: (optional) name of the field that should be populated with the `firebase.firestore.QuerySnapshot.ref` property.
   - `snapshotListenOptions`: (optional) `firebase.firestore.SnapshotListenOptions` to customise how the collection is loaded
+  - `snapshotOptions`: (optional) `firebase.firestore.SnapshotOptions` to customise how data is retrieved from snapshots
 
 Returns:
 
@@ -130,7 +131,7 @@ Returns:
 ### useCollectionDataOnce
 
 ```js
-const [values, loading, error] = useCollectionDataOnce<T>(query, options);
+const [values, loading, error] = useCollectionDataOnce < T > (query, options);
 ```
 
 As `useCollectionData`, but this hook will only read the current value of the `firebase.firestore.Query`.
@@ -142,6 +143,7 @@ The `useCollectionDataOnce` hook takes the following parameters:
   - `getOptions`: (optional) `firebase.firestore.GetOptions` to customise how the collection is loaded
   - `idField`: (optional) name of the field that should be populated with the `firebase.firestore.QuerySnapshot.id` property.
   - `refField`: (optional) name of the field that should be populated with the `firebase.firestore.QuerySnapshot.ref` property.
+  - `snapshotOptions`: (optional) `firebase.firestore.SnapshotOptions` to customise how data is retrieved from snapshots
 
 Returns:
 
@@ -216,7 +218,7 @@ Returns:
 ### useDocumentData
 
 ```js
-const [value, loading, error] = useDocumentData<T>(reference, options);
+const [value, loading, error] = useDocumentData < T > (reference, options);
 ```
 
 As `useDocument`, but this hook extracts the typed contents of `firebase.firestore.DocumentSnapshot.val()`, rather than the
@@ -229,6 +231,7 @@ The `useDocumentData` hook takes the following parameters:
   - `idField`: (optional) name of the field that should be populated with the `firebase.firestore.DocumentSnapshot.id` property.
   - `refField`: (optional) name of the field that should be populated with the `firebase.firestore.QuerySnapshot.ref` property.
   - `snapshotListenOptions`: (optional) `firebase.firestore.SnapshotListenOptions` to customise how the collection is loaded
+  - `snapshotOptions`: (optional) `firebase.firestore.SnapshotOptions` to customise how data is retrieved from snapshots
 
 Returns:
 
@@ -239,7 +242,7 @@ Returns:
 ### useDocumentDataOnce
 
 ```js
-const [value, loading, error] = useDocumentDataOnce<T>(reference, options);
+const [value, loading, error] = useDocumentDataOnce < T > (reference, options);
 ```
 
 As `useDocument`, but this hook will only read the current value of the `firebase.firestore.DocumentReference`.
@@ -251,6 +254,7 @@ The `useDocumentDataOnce` hook takes the following parameters:
   - `getOptions`: (optional) `firebase.firestore.GetOptions` to customise how the collection is loaded
   - `idField`: (optional) name of the field that should be populated with the `firebase.firestore.DocumentSnapshot.id` property.
   - `refField`: (optional) name of the field that should be populated with the `firebase.firestore.QuerySnapshot.ref` property.
+  - `snapshotOptions`: (optional) `firebase.firestore.SnapshotOptions` to customise how data is retrieved from snapshots
 
 Returns:
 

firestore/helpers/index.ts

@@ -2,6 +2,7 @@ import firebase from 'firebase/app';
 
 export const snapshotToData = (
   snapshot: firebase.firestore.DocumentSnapshot,
+  snapshotOptions?: firebase.firestore.SnapshotOptions,
   idField?: string,
   refField?: string
 ) => {
@@ -10,7 +11,7 @@ export const snapshotToData = (
   }
 
   return {
-    ...snapshot.data(),
+    ...snapshot.data(snapshotOptions),
     ...(idField ? { [idField]: snapshot.id } : null),
     ...(refField ? { [refField]: snapshot.ref } : null),
   };

firestore/types.ts

@@ -4,6 +4,7 @@ import { LoadingHook } from '../util';
 type IDOptions = {
   idField?: string;
   refField?: string;
+  snapshotOptions?: firebase.firestore.SnapshotOptions;
 };
 export type Options = {
   snapshotListenOptions?: firebase.firestore.SnapshotListenOptions;

firestore/useCollection.ts

@@ -104,6 +104,7 @@ const useCollectionDataInternal = <
 ): CollectionDataHook<T, IDField, RefField> => {
   const idField = options ? options.idField : undefined;
   const refField = options ? options.refField : undefined;
+  const snapshotOptions = options ? options.snapshotOptions : undefined;
   const [snapshots, loading, error] = useCollectionInternal<T>(
     listen,
     query,
@@ -112,7 +113,9 @@ const useCollectionDataInternal = <
   const values = useMemo(
     () =>
       (snapshots
-        ? snapshots.docs.map((doc) => snapshotToData(doc, idField, refField))
+        ? snapshots.docs.map((doc) =>
+            snapshotToData(doc, snapshotOptions, idField, refField)
+          )
         : undefined) as Data<T, IDField, RefField>[],
     [snapshots, idField, refField]
   );

firestore/useDocument.ts

@@ -104,6 +104,7 @@ const useDocumentDataInternal = <
 ): DocumentDataHook<T, IDField, RefField> => {
   const idField = options ? options.idField : undefined;
   const refField = options ? options.refField : undefined;
+  const snapshotOptions = options ? options.snapshotOptions : undefined;
   const [snapshot, loading, error] = useDocumentInternal<T>(
     listen,
     docRef,
@@ -112,7 +113,7 @@ const useDocumentDataInternal = <
   const value = useMemo(
     () =>
       (snapshot
-        ? snapshotToData(snapshot, idField, refField)
+        ? snapshotToData(snapshot, snapshotOptions, idField, refField)
         : undefined) as Data<T, IDField, RefField>,
     [snapshot, idField, refField]
   );