Make similar changes to #80 for the realtime database

Author: chrisbianca

database/README.md

@@ -98,7 +98,8 @@ The `useListVals` hook takes the following parameters:
 
 - `reference`: (optional) `firebase.database.Reference` for the data you would like to load
 - `options`: (optional) `Object` with the following parameters:
-  - `keyField`: (optional) `string` field name that should be populated with the `firebase.firestore.QuerySnapshot.id` property in the returned values
+  - `keyField`: (optional) `string` field name that should be populated with the `firebase.database.DataSnapshot.id` property in the returned values.
+  - `refField`: (optional) `string` field name that should be populated with the `firebase.database.DataSnapshot.ref` property.
 
 Returns:
 
@@ -158,6 +159,7 @@ The `useObjectVal` hook takes the following parameters:
 - `reference`: (optional) `firebase.database.Reference` for the data you would like to load
 - `options`: (optional) `Object` with the following parameters:
   - `keyField`: (optional) `string` field name that should be populated with the `firebase.database.DataSnapshot.key` property in the returned value.
+  - `refField`: (optional) `string` field name that should be populated with the `firebase.database.DataSnapshot.ref` property.
 
 Returns:
 

database/helpers/index.ts

@@ -5,7 +5,8 @@ const isObject = (val: any) =>
 
 export const snapshotToData = (
   snapshot: firebase.database.DataSnapshot,
-  keyField?: string
+  keyField?: string,
+  refField?: string
 ) => {
   if (!snapshot.exists) {
     return undefined;
@@ -16,6 +17,7 @@ export const snapshotToData = (
     return {
       ...val,
       ...(keyField ? { [keyField]: snapshot.key } : null),
+      ...(refField ? { [refField]: snapshot.ref } : null),
     };
   }
   return val;

database/useList.ts

@@ -68,52 +68,45 @@ export const useList = (query?: firebase.database.Query | null): ListHook => {
   }, [ref.current]);
 
   const resArray: ListHook = [state.value.values, state.loading, state.error];
-  return useMemo(
-    () => resArray,
-    resArray,
-  );
+  return useMemo(() => resArray, resArray);
 };
 
 export const useListKeys = (
   query?: firebase.database.Query | null
 ): ListKeysHook => {
   const [snapshots, loading, error] = useList(query);
   const values = useMemo(
-    () => (snapshots ? snapshots.map(snapshot => snapshot.key as string) : undefined),
+    () =>
+      snapshots
+        ? snapshots.map((snapshot) => snapshot.key as string)
+        : undefined,
     [snapshots]
   );
-  const resArray: ListKeysHook = [
-    values,
-    loading,
-    error,
-  ];
-
-  return useMemo(
-    () => resArray,
-    resArray,
-  );
+  const resArray: ListKeysHook = [values, loading, error];
+
+  return useMemo(() => resArray, resArray);
 };
 
 export const useListVals = <T>(
   query?: firebase.database.Query | null,
   options?: {
     keyField?: string;
+    refField?: string;
   }
 ): ListValsHook<T> => {
+  const keyField = options ? options.keyField : undefined;
+  const refField = options ? options.refField : undefined;
   const [snapshots, loading, error] = useList(query);
   const values = useMemo(
     () =>
       snapshots
         ? snapshots.map((snapshot) =>
-            snapshotToData(snapshot, options ? options.keyField : undefined)
+            snapshotToData(snapshot, keyField, refField)
           )
         : undefined,
     [snapshots, options && options.keyField]
   );
 
   const resArray: ListValsHook<T> = [values, loading, error];
-  return useMemo(
-    () => resArray,
-    resArray,
-  );
+  return useMemo(() => resArray, resArray);
 };

database/useObject.ts

@@ -33,30 +33,24 @@ export const useObject = (
   }, [ref.current]);
 
   const resArray: ObjectHook = [value, loading, error];
-  return useMemo(
-    () => resArray,
-    resArray,
-  );
+  return useMemo(() => resArray, resArray);
 };
 
 export const useObjectVal = <T>(
   query?: firebase.database.Query | null,
   options?: {
     keyField?: string;
+    refField?: string;
   }
 ): ObjectValHook<T> => {
+  const keyField = options ? options.keyField : undefined;
+  const refField = options ? options.refField : undefined;
   const [snapshot, loading, error] = useObject(query);
   const value = useMemo(
-    () =>
-      snapshot
-        ? snapshotToData(snapshot, options ? options.keyField : undefined)
-        : undefined,
+    () => (snapshot ? snapshotToData(snapshot, keyField, refField) : undefined),
     [snapshot, options && options.keyField]
   );
 
   const resArray: ObjectValHook<T> = [value, loading, error];
-  return useMemo(
-    () => resArray,
-    resArray,
-  );
+  return useMemo(() => resArray, resArray);
 };