performance package
Stay organized with collections
Save and categorize content based on your preferences.
The Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment.
Functions
Interfaces
function(app, ...)
Returns a FirebasePerformance instance for the given app.
Signature:
export declare function getPerformance(app?: FirebaseApp): FirebasePerformance;
Parameters
Returns:
FirebasePerformance
Returns a FirebasePerformance instance for the given app. Can only be called once.
Signature:
export declare function initializePerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;
Parameters
Returns:
FirebasePerformance
trace(performance, name)
Returns a new PerformanceTrace instance.
Signature:
export declare function trace(performance: FirebasePerformance, name: string): PerformanceTrace;
Parameters
Returns:
PerformanceTrace
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-01-19 UTC.
[null,null,["Last updated 2024-01-19 UTC."],[],[],null,["# performance package\n\nThe Firebase Performance Monitoring Web SDK. This SDK does not work in a Node.js environment.\n\nFunctions\n---------\n\n| Function | Description |\n|----------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **function(app, ...)** | |\n| [getPerformance(app)](./performance.md#getperformance_cf608e1) | Returns a [FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface) instance for the given app. |\n| [initializePerformance(app, settings)](./performance.md#initializeperformance_980350e) | Returns a [FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface) instance for the given app. Can only be called once. |\n| **function(performance, ...)** | |\n| [trace(performance, name)](./performance.md#trace_62e4b7e) | Returns a new `PerformanceTrace` instance. |\n\nInterfaces\n----------\n\n| Interface | Description |\n|-------------------------------------------------------------------------------------------|-------------------------------------------------------------------|\n| [FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface) | The Firebase Performance Monitoring service interface. |\n| [PerformanceSettings](./performance.performancesettings.md#performancesettings_interface) | Defines configuration options for the Performance Monitoring SDK. |\n| [PerformanceTrace](./performance.performancetrace.md#performancetrace_interface) | The interface representing a `Trace`. |\n\nfunction(app, ...)\n------------------\n\n### getPerformance(app)\n\nReturns a [FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface) instance for the given app.\n\n**Signature:** \n\n export declare function getPerformance(app?: FirebaseApp): FirebasePerformance;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-----------|-----------------------------------------------------------|-----------------------------------------------------------------------|\n| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) to use. |\n\n**Returns:**\n\n[FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface)\n\n### initializePerformance(app, settings)\n\nReturns a [FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface) instance for the given app. Can only be called once.\n\n**Signature:** \n\n export declare function initializePerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-----------|-------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------|\n| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | The [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) to use. |\n| settings | [PerformanceSettings](./performance.performancesettings.md#performancesettings_interface) | Optional settings for the [FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface) instance. |\n\n**Returns:**\n\n[FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface)\n\nfunction(performance, ...)\n--------------------------\n\n### trace(performance, name)\n\nReturns a new `PerformanceTrace` instance.\n\n**Signature:** \n\n export declare function trace(performance: FirebasePerformance, name: string): PerformanceTrace;\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-------------|-------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|\n| performance | [FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface) | The [FirebasePerformance](./performance.firebaseperformance.md#firebaseperformance_interface) instance to use. |\n| name | string | The name of the trace. |\n\n**Returns:**\n\n[PerformanceTrace](./performance.performancetrace.md#performancetrace_interface)"]]
