From 6886ed122d5e3247a594cf6295f049e1995465fc Mon Sep 17 00:00:00 2001 From: Kiyohiko Heima Date: Sun, 13 Nov 2022 09:20:45 +0900 Subject: [PATCH] fix(useFirestore): fix falsy type error (#2431) --- packages/firebase/useFirestore/index.md | 4 ++-- packages/firebase/useFirestore/index.ts | 14 ++++++++------ 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/packages/firebase/useFirestore/index.md b/packages/firebase/useFirestore/index.md index f0998ab0c42..f9ca78821f9 100644 --- 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 index ae065cff896..074ceaede8e 100644 --- a/packages/firebase/useFirestore/index.ts +++ b/packages/firebase/useFirestore/index.ts @@ -33,25 +33,27 @@ function isDocumentReference(docRef: any): docRef is DocumentReference { return (docRef.path?.match(/\//g) || []).length % 2 !== 0 } +type Falsy = false | 0 | '' | null | undefined + export function useFirestore( - maybeDocRef: MaybeRef | false>, + maybeDocRef: MaybeRef | Falsy>, initialValue: T, options?: UseFirestoreOptions ): Ref export function useFirestore( - maybeDocRef: MaybeRef | false>, + maybeDocRef: MaybeRef | Falsy>, initialValue: T[], options?: UseFirestoreOptions ): Ref // nullable initial values export function useFirestore( - maybeDocRef: MaybeRef | false>, - initialValue?: T | undefined, + maybeDocRef: MaybeRef | Falsy>, + initialValue?: T | undefined | null, options?: UseFirestoreOptions, ): Ref export function useFirestore( - maybeDocRef: MaybeRef | false>, + maybeDocRef: MaybeRef | Falsy>, initialValue?: T[], options?: UseFirestoreOptions ): Ref @@ -63,7 +65,7 @@ export function useFirestore( * @see https://vueuse.org/useFirestore */ export function useFirestore( - maybeDocRef: MaybeRef | false>, + maybeDocRef: MaybeRef | Falsy>, initialValue: any = undefined, options: UseFirestoreOptions = {}, ) {