Class Firebase

constructor

• new Firebase(params?: Partial<FirebaseParams>): Firebase

  Creates a Firebase class

  Parameters

  • params: Partial<FirebaseParams> = {}

    Initialization parameters

  Returns Firebase

loginAnonymously

• loginAnonymously(): Promise<FirebaseAuthResponse | ErrorEnum<FirebaseError>>

  Logs in with an anonymous account (not tied to any credentials)

  Returns Promise<FirebaseAuthResponse | ErrorEnum<FirebaseError>>

  A successful authentication response or the error

loginWithEmailPass

• loginWithEmailPass(
      authType: "signUp" | "signInWithPassword",
      email: string,
      password: string,
  ): Promise<FirebaseAuthResponse | ErrorEnum<FirebaseError>>

  Logs in or creates an account with email and password authentication

  Parameters

  • authType: "signUp" | "signInWithPassword"

    See AuthType; whether to create an account or log in

  • email: string

    The email to log in with or create an account with

  • password: string

    The password to log in with or create an account with

  Returns Promise<FirebaseAuthResponse | ErrorEnum<FirebaseError>>

  A successful authentication response or the error

loginWithRefreshToken

• loginWithRefreshToken(
      refreshToken: string,
  ): Promise<FirebaseAuthResponse | ErrorEnum<FirebaseError>>

  Logs in with a refresh token

  Parameters

  • refreshToken: string

    The refresh token to log in with

  Returns Promise<FirebaseAuthResponse | ErrorEnum<FirebaseError>>

  A successful authentication response or the error

sendEmailVerification

• sendEmailVerification(
      idToken?: string | null,
  ): Promise<FirebaseEmailResponse | ErrorEnum<FirebaseError>>

  Sends email verification to the email with an ID token

  Parameters

  • idToken: string | null = ...

    The ID token to send; defaults to the last ID token obtained from a successful authentication method on the instance

  Returns Promise<FirebaseEmailResponse | ErrorEnum<FirebaseError>>

  A successful email verification response or the error

verifyOobCode

• verifyOobCode(
      oobCode: string,
  ): Promise<FirebaseEmailResponse | ErrorEnum<FirebaseError>>

  Verifies an OOB code from an email verification link

  Parameters

  • oobCode: string

    The OOB code to verify from the email verification link

  Returns Promise<FirebaseEmailResponse | ErrorEnum<FirebaseError>>

  A successful email verification response or the error

Static ReadonlyAuthType