docs: useAuth()

posva · posva · commit 103b3309507c · 2022-12-08T13:37:41.000+01:00
diff --git a/src/auth/index.ts b/src/auth/index.ts
@@ -40,7 +40,8 @@ export function VueFireAuth(initialUser?: _Nullable<User>) {
 }
 
 /**
- * Retrieves the Firebase Auth instance. Returns `null` on the server.
+ * Retrieves the Firebase Auth instance. **Returns `null` on the server**. When using this function on the client in
+ * TypeScript, you can force the type with `useFirebaseAuth()!`.
  *
  * @param name - name of the application
  * @returns the Auth instance

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,8 @@ export function VueFireAuth(initialUser?: _Nullable<User>) {`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`/**`
`43`		- * Retrieves the Firebase Auth instance. Returns `null` on the server.
	`43`	+ * Retrieves the Firebase Auth instance. Returns `null` on the server. When using this function on the client in
	`44`	+ * TypeScript, you can force the type with `useFirebaseAuth()!`.
`44`	`45`	`*`
`45`	`46`	`* @param name - name of the application`
`46`	`47`	`* @returns the Auth instance`