Skip to main content
Capgo logo
← Back To Plugins

Using @capgo/capacitor-firebase-crashlytics

Capacitor plugin for Firebase Crashlytics.

Install

bun add @capgo/capacitor-firebase-crashlytics
bunx cap sync

What This Plugin Exposes

  • crash - Forces a crash to test the implementation.
  • setCustomKey - Sets a custom key and value that is associated with subsequent fatal and non-fatal reports.
  • setUserId - Sets a user ID (identifier) that is associated with subsequent fatal and non-fatal reports.
  • log - Adds a custom log message that is sent with your crash data to give yourself more context for the events leading up to a crash.

Example Usage

crash

Forces a crash to test the implementation.

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.crash({} as CrashOptions);

setCustomKey

Sets a custom key and value that is associated with subsequent fatal and non-fatal reports.

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.setCustomKey({} as SetCustomKeyOptions);

setUserId

Sets a user ID (identifier) that is associated with subsequent fatal and non-fatal reports.

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.setUserId({} as SetUserIdOptions);

log

Adds a custom log message that is sent with your crash data to give yourself more context for the events leading up to a crash.

import { FirebaseCrashlytics } from '@capgo/capacitor-firebase-crashlytics';

await FirebaseCrashlytics.log({} as LogOptions);

Full Reference