@firebase/crashlytics/angular

Functions

Function Description
provideCrashlytics(getAppFn, options) (Public Preview) Registers Firebase Crashlytics error handling and route tracking providers for an Angular application.

Interfaces

Interface Description
Crashlytics (Public Preview) An instance of the Firebase Crashlytics SDK.Do not create this instance directly. Instead, use getCrashlytics().
CrashlyticsFeature (EXPERIMENTAL) An opaque feature plugin object returned by Crashlytics feature factory functions such as breadcrumbs().
CrashlyticsOptions (Public Preview) Options for initializing the Crashlytics service using getCrashlytics().

function(getAppFn, ...)

provideCrashlytics(getAppFn, options)

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Registers Firebase Crashlytics error handling and route tracking providers for an Angular application.

Signature:

export declare function provideCrashlytics(getAppFn: () => FirebaseApp, options?: CrashlyticsOptions): EnvironmentProviders;

Parameters

Parameter Type Description
getAppFn () => FirebaseApp A factory function that returns the FirebaseApp instance to use.
options CrashlyticsOptions Optional. CrashlyticsOptions that configure the Crashlytics instance.

Returns:

EnvironmentProviders

An EnvironmentProviders instance to include in ApplicationConfig.providers.

Example 1

Basic usage:

import { ApplicationConfig } from '@angular/core';
import { provideRouter } from '@angular/router';
import { provideCrashlytics } from 'firebase/crashlytics/angular';
import { app } from '../lib/firebase';
import { routes } from './app.routes';

export const appConfig: ApplicationConfig = {
  providers: [
    provideRouter(routes),
    provideCrashlytics(() => app)
  ]
};

Example 2

Providing telemetry options:

import { ApplicationConfig } from '@angular/core';
import { provideRouter } from '@angular/router';
import { provideCrashlytics } from 'firebase/crashlytics/angular';
import { app } from '../lib/firebase';
import { routes } from './app.routes';

export const appConfig: ApplicationConfig = {
  providers: [
    provideRouter(routes),
    provideCrashlytics(() => app, { appVersion: '1.2.3' })
  ]
};