@firebase/crashlytics

The Firebase Crashlytics Web SDK. This product is currently in public preview.

Functions

Interfaces

function(app, ...)

getCrashlytics(app, 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.

Returns the default Crashlytics instance that is associated with the provided FirebaseApp. If no instance exists, initializes a new instance with the default settings.

Signature:

export declare function getCrashlytics(app?: FirebaseApp, options?: CrashlyticsOptions): Crashlytics;

Parameters

Returns:

Crashlytics

The default Crashlytics instance for the given FirebaseApp.

Example

const crashlytics = getCrashlytics(app);

function()

breadcrumbs()

(EXPERIMENTAL) Enables Crashlytics breadcrumb and trace telemetry collection when passed in CrashlyticsOptions.features.

When enabled, Crashlytics collects OpenTelemetry spans (such as Fetch, XMLHttpRequest, and Document Load) and breadcrumb logs (such as navigation events, Web Vitals, user actions, and visibility lifecycle events), buffering them in memory and exporting them when an error occurs.

Signature:

export declare function breadcrumbs(): CrashlyticsFeature;

Returns:

CrashlyticsFeature

Example

import { getCrashlytics, breadcrumbs } from 'firebase/crashlytics';

const crashlytics = getCrashlytics(app, {
  features: [breadcrumbs()]
});

function(crashlytics, ...)

flush(crashlytics)

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.

Flushes all enqueued Crashlytics data immediately, instead of waiting for default batching.

Signature:

export declare function flush(crashlytics: Crashlytics): Promise<void>;

Parameters

Returns:

Promise<void>

a promise which is resolved when all flushes are complete

log(crashlytics, message, attributes)

(EXPERIMENTAL) Queues a log message to be uploaded to the Firebase Crashlytics API.

Signature:

export declare function log(crashlytics: Crashlytics, message: string, attributes?: AnyValueMap): void;

Parameters

Returns:

void

recordError(crashlytics, error, attributes)

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.

Queues an error to be uploaded to the Firebase Crashlytics API.

Signature:

export declare function recordError(crashlytics: Crashlytics, error: unknown, attributes?: AnyValueMap): void;

Parameters

Returns:

void