Skip to main content
Version: 2.0.0-alpha

Type alias: AuthDelegate<UserType>

Ƭ AuthDelegate<UserType>: Object

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

Type parameters

NameType
UserTypeextends User = User

Type declaration

NameTypeDescription
authError?anyError dispatched by the auth provider
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.
loginSkipped?booleanHas the user skipped the login process
userUserType | nullThe user currently logged in The values can be: the user object, null if they skipped login
signOut() => voidSign out
skipLogin?() => voidSkip login

Defined in

lib/src/models/auth.tsx:79