Skip to main content
Version: 2.0.0-alpha

Type alias: AuthController<UserType>

Ƭ AuthController<UserType>: Object

Controller for retrieving the logged user or performing auth related operations. Note that if you are implementing your AuthController, you probably will want to do it as the result of a hook. Check useFirebaseAuthController code for an example.

Type parameters

NameType
UserTypeextends User = User

Type declaration

NameTypeDescription
authError?anyError dispatched by the auth provider
authLoadingbooleanIf you have defined an Authenticator, this flag will be set to true while it loads
extra?anyUtility field you can use to store your custom data. e.g: Additional user data fetched from a Firestore document, or custom claims
initialLoading?booleanInitial loading flag. It is used not to display the login screen when the app first loads, and it has not been checked whether the user is logged in or not.
setExtra(extra: any) => voidYou can use this method to store any extra data you would like to associate your user to. e.g: Additional user data fetched from a Firestore document, or custom claims
signOut() => voidSign out
userUserType | nullThe user currently logged in The values can be: the user object, null if they skipped login

Defined in

lib/src/models/auth.tsx:10