fix(useFirestore): fix falsy type error (#2431)

vueuse · Nov 13, 2022 · 6886ed1 · 6886ed1
1 parent 2aa3e67
commit 6886ed1
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 8 deletions.
diff --git a/packages/firebase/useFirestore/index.md b/packages/firebase/useFirestore/index.md
@@ -30,8 +30,8 @@ const posts = useFirestore(postsQuery)
 // you can use the boolean value to tell a query when it is ready to run
 // when it gets falsy value, return the initial value
 const userId = ref('')
-const userQuery = computed(() => !!userId.value && doc(db, 'users', userId.value))
-const userData = useFirestore(userQuery, [])
+const userQuery = computed(() => userId.value && doc(db, 'users', userId.value))
+const userData = useFirestore(userQuery, null)
 ```
 
 ## Share across instances

diff --git a/packages/firebase/useFirestore/index.ts b/packages/firebase/useFirestore/index.ts
@@ -33,25 +33,27 @@ function isDocumentReference<T>(docRef: any): docRef is DocumentReference<T> {
   return (docRef.path?.match(/\//g) || []).length % 2 !== 0
 }
 
+type Falsy = false | 0 | '' | null | undefined
+
 export function useFirestore<T extends DocumentData>(
-  maybeDocRef: MaybeRef<DocumentReference<T> | false>,
+  maybeDocRef: MaybeRef<DocumentReference<T> | Falsy>,
   initialValue: T,
   options?: UseFirestoreOptions
 ): Ref<T | null>
 export function useFirestore<T extends DocumentData>(
-  maybeDocRef: MaybeRef<Query<T> | false>,
+  maybeDocRef: MaybeRef<Query<T> | Falsy>,
   initialValue: T[],
   options?: UseFirestoreOptions
 ): Ref<T[]>
 
 // nullable initial values
 export function useFirestore<T extends DocumentData>(
-  maybeDocRef: MaybeRef<DocumentReference<T> | false>,
-  initialValue?: T | undefined,
+  maybeDocRef: MaybeRef<DocumentReference<T> | Falsy>,
+  initialValue?: T | undefined | null,
   options?: UseFirestoreOptions,
 ): Ref<T | undefined | null>
 export function useFirestore<T extends DocumentData>(
-  maybeDocRef: MaybeRef<Query<T> | false>,
+  maybeDocRef: MaybeRef<Query<T> | Falsy>,
   initialValue?: T[],
   options?: UseFirestoreOptions
 ): Ref<T[] | undefined>
@@ -63,7 +65,7 @@ export function useFirestore<T extends DocumentData>(
  * @see https://vueuse.org/useFirestore
  */
 export function useFirestore<T extends DocumentData>(
-  maybeDocRef: MaybeRef<FirebaseDocRef<T> | false>,
+  maybeDocRef: MaybeRef<FirebaseDocRef<T> | Falsy>,
   initialValue: any = undefined,
   options: UseFirestoreOptions = {},
 ) {