@firebase/auth-types

What is @firebase/auth-types?

The @firebase/auth-types package provides TypeScript type definitions for Firebase Authentication. This package is primarily used in development environments where TypeScript is used to ensure type safety and to assist with code completion and error checking in IDEs. It does not contain implementation code but rather type annotations for various authentication features in Firebase.

What are @firebase/auth-types's main functionalities?

User Authentication Types

Defines types for user objects in Firebase Authentication, helping developers manage user data such as display names and email addresses safely.

import { User } from '@firebase/auth-types';

function getUserDetails(user: User) {
  console.log(user.displayName);
  console.log(user.email);
}

Authentication Service Types

Provides type definitions for the FirebaseAuth service, which includes properties and methods for initializing and configuring the authentication service.

import { FirebaseAuth } from '@firebase/auth-types';

function initializeAuth(auth: FirebaseAuth) {
  console.log(auth.app.name);
}

Auth Credential Types

Includes type definitions for authentication credentials, which are used when signing in a user or linking/unlinking auth providers.

import { AuthCredential } from '@firebase/auth-types';

function authenticateUser(credential: AuthCredential) {
  console.log(credential.providerId);
}

Other packages similar to @firebase/auth-types

@types/firebase

This package provides general TypeScript definitions for Firebase, including authentication but also covering other Firebase services like Firestore, Functions, etc. It's broader in scope compared to @firebase/auth-types, which is specifically focused on authentication types.

firebase-admin

While primarily used for server-side Firebase interactions, firebase-admin includes authentication features and types for Node.js environments. It offers more comprehensive control over Firebase services compared to @firebase/auth-types, which is client-side and type-focused.

README

@firebase/auth-types

This package is not intended for direct usage, and should only be used via the officially supported firebase package.