feat: Allow an initialValue to be passed as an option on data methods

Author: dylanwatsonsoftware

firestore/types.ts

@@ -11,6 +11,9 @@ export type Options = {
   snapshotListenOptions?: firebase.firestore.SnapshotListenOptions;
 };
 export type DataOptions<T> = Options & IDOptions<T>;
+export type InitialValueOptions<T> = {
+  initialValue?: T;
+};
 export type OnceOptions = {
   getOptions?: firebase.firestore.GetOptions;
 };

firestore/useCollection.ts

@@ -9,6 +9,7 @@ import {
   OnceOptions,
   OnceDataOptions,
   Options,
+  InitialValueOptions,
 } from './types';
 import { useIsEqualRef, useLoadingValue } from '../util';
 
@@ -32,7 +33,7 @@ export const useCollectionData = <
   RefField extends string = ''
 >(
   query?: firebase.firestore.Query | null,
-  options?: DataOptions<T>
+  options?: DataOptions<T> & InitialValueOptions<T[]>
 ): CollectionDataHook<T, IDField, RefField> => {
   return useCollectionDataInternal<T, IDField, RefField>(true, query, options);
 };
@@ -43,7 +44,7 @@ export const useCollectionDataOnce = <
   RefField extends string = ''
 >(
   query?: firebase.firestore.Query | null,
-  options?: OnceDataOptions<T>
+  options?: OnceDataOptions<T> & InitialValueOptions<T[]>
 ): CollectionDataHook<T, IDField, RefField> => {
   return useCollectionDataInternal<T, IDField, RefField>(false, query, options);
 };
@@ -100,7 +101,7 @@ const useCollectionDataInternal = <
 >(
   listen: boolean,
   query?: firebase.firestore.Query | null,
-  options?: DataOptions<T> & OnceDataOptions<T>
+  options?: DataOptions<T> & OnceDataOptions<T> & InitialValueOptions<T[]>
 ): CollectionDataHook<T, IDField, RefField> => {
   const idField = options ? options.idField : undefined;
   const refField = options ? options.refField : undefined;
@@ -123,7 +124,7 @@ const useCollectionDataInternal = <
               transform
             )
           )
-        : undefined) as Data<T, IDField, RefField>[],
+        : options && options.initialValue) as Data<T, IDField, RefField>[],
     [snapshots, snapshotOptions, idField, refField, transform]
   );
 

firestore/useDocument.ts

@@ -9,6 +9,7 @@ import {
   OnceOptions,
   OnceDataOptions,
   Options,
+  InitialValueOptions,
 } from './types';
 import { useIsEqualRef, useLoadingValue } from '../util';
 
@@ -32,7 +33,7 @@ export const useDocumentData = <
   RefField extends string = ''
 >(
   docRef?: firebase.firestore.DocumentReference | null,
-  options?: DataOptions<T>
+  options?: DataOptions<T> & InitialValueOptions<T>
 ): DocumentDataHook<T, IDField, RefField> => {
   return useDocumentDataInternal<T, IDField, RefField>(true, docRef, options);
 };
@@ -43,7 +44,7 @@ export const useDocumentDataOnce = <
   RefField extends string = ''
 >(
   docRef?: firebase.firestore.DocumentReference | null,
-  options?: OnceDataOptions<T>
+  options?: OnceDataOptions<T> & InitialValueOptions<T>
 ): DocumentDataHook<T, IDField, RefField> => {
   return useDocumentDataInternal<T, IDField, RefField>(false, docRef, options);
 };
@@ -100,7 +101,7 @@ const useDocumentDataInternal = <
 >(
   listen: boolean,
   docRef?: firebase.firestore.DocumentReference | null,
-  options?: DataOptions<T>
+  options?: DataOptions<T> & InitialValueOptions<T>
 ): DocumentDataHook<T, IDField, RefField> => {
   const idField = options ? options.idField : undefined;
   const refField = options ? options.refField : undefined;
@@ -121,7 +122,7 @@ const useDocumentDataInternal = <
             refField,
             transform
           )
-        : undefined) as Data<T, IDField, RefField>,
+        : options && options.initialValue) as Data<T, IDField, RefField>,
     [snapshot, snapshotOptions, idField, refField, transform]
   );