Interface Auth

interface Auth {
    app: ReactNativeFirebase.FirebaseApp;
    config: Config;
    currentUser: User | null;
    emulatorConfig: EmulatorConfig | null;
    languageCode: string | null;
    name: string;
    settings: AuthSettings;
    tenantId: string | null;
    authStateReady(): Promise<void>;
    beforeAuthStateChanged(
        callback: (user: User | null) => void | Promise<void>,
        onAbort?: () => void,
    ): Unsubscribe;
    onAuthStateChanged(
        nextOrObserver: NextOrObserver<User | null>,
        error?: ErrorFn,
        completed?: CompleteFn,
    ): Unsubscribe;
    onIdTokenChanged(
        nextOrObserver: NextOrObserver<User | null>,
        error?: ErrorFn,
        completed?: CompleteFn,
    ): Unsubscribe;
    setPersistence(persistence: Persistence): Promise<void>;
    signOut(): Promise<void>;
    updateCurrentUser(user: User | null): Promise<void>;
    useDeviceLanguage(): void;
}

Index

Methods

authStateReady beforeAuthStateChanged onAuthStateChanged onIdTokenChanged setPersistence signOut updateCurrentUser useDeviceLanguage

Properties

app config currentUser emulatorConfig languageCode name settings tenantId

Methods

authStateReady

authStateReady(): Promise<void>
Resolves when the initial auth state has been determined.

Returns Promise<void>
- Defined in auth/lib/types/auth.ts:70

beforeAuthStateChanged

beforeAuthStateChanged(
callback: (user: User | null) => void | Promise<void>,
onAbort?: () => void,
): Unsubscribe
Parameters
- callback: (user: User | null) => void | Promise<void>
- OptionalonAbort: () => void
Returns Unsubscribe
- Defined in auth/lib/types/auth.ts:60

onAuthStateChanged

onAuthStateChanged(
    nextOrObserver: NextOrObserver<User | null>,
    error?: ErrorFn,
    completed?: CompleteFn,
): Unsubscribe
Parameters
- nextOrObserver: NextOrObserver<User | null>
- Optionalerror: ErrorFn
- Optionalcompleted: CompleteFn
Returns Unsubscribe
- Defined in auth/lib/types/auth.ts:55

onIdTokenChanged

onIdTokenChanged(
    nextOrObserver: NextOrObserver<User | null>,
    error?: ErrorFn,
    completed?: CompleteFn,
): Unsubscribe
Parameters
- nextOrObserver: NextOrObserver<User | null>
- Optionalerror: ErrorFn
- Optionalcompleted: CompleteFn
Returns Unsubscribe
- Defined in auth/lib/types/auth.ts:64

setPersistence

setPersistence(persistence: Persistence): Promise<void>
Parameters
- persistence: Persistence
Returns Promise<void>
Remarks
Not supported on React Native Firebase. The modular setPersistence helper always throws synchronously because auth state is managed by the native SDKs.
- Defined in auth/lib/types/auth.ts:50

signOut

signOut(): Promise<void>
Returns Promise<void>
- Defined in auth/lib/types/auth.ts:81

updateCurrentUser

updateCurrentUser(user: User | null): Promise<void>
Parameters
- user: User | null
Returns Promise<void>
- Defined in auth/lib/types/auth.ts:74

useDeviceLanguage

useDeviceLanguage(): void
Returns void
Remarks
Not supported on React Native Firebase. Always throws synchronously. Set languageCode directly or use setLanguageCode.
- Defined in auth/lib/types/auth.ts:80

Properties

`Readonly`app

app: ReactNativeFirebase.FirebaseApp

`Readonly`config

config: Config

Remarks

Always returns {} at runtime. Native iOS/Android Firebase Auth SDKs do not expose the web config object.

`Readonly`currentUser

currentUser: User | null

`Readonly`emulatorConfig

emulatorConfig: EmulatorConfig | null

Populated after connectAuthEmulator is called; otherwise null.

languageCode

languageCode: string | null

`Readonly`name

name: string

`Readonly`settings

settings: AuthSettings

tenantId

tenantId: string | null

Writable tenant ID. Assigning a value delegates to setTenantId.