firebase-js-sdk/docs-devsite/performance.md

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

performance package

The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment.

Functions

Function	Description
function(app, ...)
getPerformance(app)	Returns a FirebasePerformance instance for the given app.
initializePerformance(app, settings)	Returns a FirebasePerformance instance for the given app. Can only be called once.
function(performance, ...)
trace(performance, name)	Returns a new PerformanceTrace instance.

Interfaces

Interface	Description
FirebasePerformance	The Firebase Performance Monitoring service interface.
PerformanceSettings	Defines configuration options for the Performance Monitoring SDK.
PerformanceTrace	The interface representing a Trace.

function(app, ...)

getPerformance(app) {:#getperformance_cf608e1}

Returns a FirebasePerformance instance for the given app.

Signature:

export declare function getPerformance(app?: FirebaseApp): FirebasePerformance;

Parameters

Parameter	Type	Description
app	FirebaseApp	The FirebaseApp to use.

Returns:

FirebasePerformance

initializePerformance(app, settings) {:#initializeperformance_980350e}

Returns a FirebasePerformance instance for the given app. Can only be called once.

Signature:

export declare function initializePerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;

Parameters

Parameter	Type	Description
app	FirebaseApp	The FirebaseApp to use.
settings	PerformanceSettings	Optional settings for the FirebasePerformance instance.

Returns:

FirebasePerformance

function(performance, ...)

trace(performance, name) {:#trace_62e4b7e}

Returns a new PerformanceTrace instance.

Signature:

export declare function trace(performance: FirebasePerformance, name: string): PerformanceTrace;

Parameters

Parameter	Type	Description
performance	FirebasePerformance	The FirebasePerformance instance to use.
name	string	The name of the trace.

Returns:

PerformanceTrace