Consolidate hook options

Author: chrisbianca

database/helpers/index.ts

@@ -1,5 +1,10 @@
 import firebase from 'firebase/app';
 
+export type ValOptions = {
+  keyField?: string;
+  refField?: string;
+};
+
 const isObject = (val: any) =>
   val != null && typeof val === 'object' && Array.isArray(val) === false;
 

database/useList.ts

@@ -1,6 +1,6 @@
 import firebase from 'firebase/app';
 import { useEffect, useMemo } from 'react';
-import { snapshotToData } from './helpers';
+import { snapshotToData, ValOptions } from './helpers';
 import useListReducer from './helpers/useListReducer';
 import { LoadingHook, useIsEqualRef } from '../util';
 
@@ -131,10 +131,7 @@ export const useListKeys = (
 
 export const useListVals = <T>(
   query?: firebase.database.Query | null,
-  options?: {
-    keyField?: string;
-    refField?: string;
-  }
+  options?: ValOptions,
 ): ListValsHook<T> => {
   const keyField = options ? options.keyField : undefined;
   const refField = options ? options.refField : undefined;

database/useObject.ts

@@ -1,6 +1,6 @@
 import firebase from 'firebase/app';
 import { useEffect, useMemo } from 'react';
-import { snapshotToData } from './helpers';
+import { snapshotToData, ValOptions } from './helpers';
 import { LoadingHook, useIsEqualRef, useLoadingValue } from '../util';
 
 export type ObjectHook = LoadingHook<
@@ -38,10 +38,7 @@ export const useObject = (
 
 export const useObjectVal = <T>(
   query?: firebase.database.Query | null,
-  options?: {
-    keyField?: string;
-    refField?: string;
-  }
+  options?: ValOptions
 ): ObjectValHook<T> => {
   const keyField = options ? options.keyField : undefined;
   const refField = options ? options.refField : undefined;

firestore/helpers/index.ts

@@ -1,5 +1,13 @@
 import firebase from 'firebase/app';
 
+export type Options = {
+  snapshotListenOptions?: firebase.firestore.SnapshotListenOptions;
+};
+export type DataOptions = Options & {
+  idField?: string;
+  refField?: string;
+};
+
 export const snapshotToData = (
   snapshot: firebase.firestore.DocumentSnapshot,
   idField?: string,

firestore/useCollection.ts

@@ -1,6 +1,6 @@
 import firebase from 'firebase/app';
 import { useEffect, useMemo } from 'react';
-import { snapshotToData } from './helpers';
+import { DataOptions, Options, snapshotToData } from './helpers';
 import { LoadingHook, useIsEqualRef, useLoadingValue } from '../util';
 
 export type CollectionHook<T> = LoadingHook<
@@ -11,9 +11,7 @@ export type CollectionDataHook<T> = LoadingHook<T[], Error>;
 
 export const useCollection = <T>(
   query?: firebase.firestore.Query | null,
-  options?: {
-    snapshotListenOptions?: firebase.firestore.SnapshotListenOptions;
-  }
+  options?: Options,
 ): CollectionHook<T> => {
   const { error, loading, reset, setError, setValue, value } = useLoadingValue<
     firebase.firestore.QuerySnapshot,
@@ -50,11 +48,7 @@ export const useCollection = <T>(
 
 export const useCollectionData = <T>(
   query?: firebase.firestore.Query | null,
-  options?: {
-    idField?: string;
-    refField?: string;
-    snapshotListenOptions?: firebase.firestore.SnapshotListenOptions;
-  }
+  options?: DataOptions
 ): CollectionDataHook<T> => {
   const idField = options ? options.idField : undefined;
   const refField = options ? options.refField : undefined;

firestore/useDocument.ts

@@ -1,6 +1,6 @@
 import firebase from 'firebase/app';
 import { useEffect, useMemo } from 'react';
-import { snapshotToData } from './helpers';
+import { DataOptions, Options, snapshotToData } from './helpers';
 import { LoadingHook, useIsEqualRef, useLoadingValue } from '../util';
 
 export type DocumentHook<T> = LoadingHook<
@@ -11,9 +11,7 @@ export type DocumentDataHook<T> = LoadingHook<T, Error>;
 
 export const useDocument = <T>(
   docRef?: firebase.firestore.DocumentReference | null,
-  options?: {
-    snapshotListenOptions?: firebase.firestore.SnapshotListenOptions;
-  }
+  options?: Options
 ): DocumentHook<T> => {
   const { error, loading, reset, setError, setValue, value } = useLoadingValue<
     firebase.firestore.DocumentSnapshot,
@@ -50,11 +48,7 @@ export const useDocument = <T>(
 
 export const useDocumentData = <T>(
   docRef?: firebase.firestore.DocumentReference | null,
-  options?: {
-    idField?: string;
-    refField?: string;
-    snapshotListenOptions?: firebase.firestore.SnapshotListenOptions;
-  }
+  options?: DataOptions,
 ): DocumentDataHook<T> => {
   const idField = options ? options.idField : undefined;
   const refField = options ? options.refField : undefined;

package.json

@@ -52,6 +52,7 @@
     "@types/react": "^17.0.0",
     "firebase": "^8.0.0",
     "path": "^0.12.7",
+    "prettier": "2.2.1",
     "react": "^17.0.1",
     "rimraf": "^2.6.2",
     "rollup": "0.57.1",