Skip to content

Commit 1ac04ad

Browse files
authored
fix tsdoc comments (#1240)
1 parent bd0fcbc commit 1ac04ad

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
- Fix reference docs for performance monitoring.

src/v2/providers/alerts/performance.ts

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,27 +38,27 @@ import {
3838
* Payload is wrapped inside a {@link FirebaseAlertData} object.
3939
*/
4040
export interface ThresholdAlertPayload {
41-
/* Name of the trace or network request this alert is for (e.g. my_custom_trace, firebase.com/api/123) */
41+
/** Name of the trace or network request this alert is for (e.g. my_custom_trace, firebase.com/api/123) */
4242
eventName: string;
43-
/* The resource type this alert is for (i.e. trace, network request, screen rendering, etc.) */
43+
/** The resource type this alert is for (i.e. trace, network request, screen rendering, etc.) */
4444
eventType: string;
45-
/* The metric type this alert is for (i.e. success rate, response time, duration, etc.) */
45+
/** The metric type this alert is for (i.e. success rate, response time, duration, etc.) */
4646
metricType: string;
47-
/* The number of events checked for this alert condition */
47+
/** The number of events checked for this alert condition */
4848
numSamples: number;
49-
/* The threshold value of the alert condition without units (e.g. "75", "2.1") */
49+
/** The threshold value of the alert condition without units (e.g. "75", "2.1") */
5050
thresholdValue: number;
51-
/* The unit for the alert threshold (e.g. "percent", "seconds") */
51+
/** The unit for the alert threshold (e.g. "percent", "seconds") */
5252
thresholdUnit: string;
53-
/* The percentile of the alert condition, can be 0 if percentile is not applicable to the alert condition and omitted; range: [1, 100] */
53+
/** The percentile of the alert condition, can be 0 if percentile is not applicable to the alert condition and omitted; range: [1, 100] */
5454
conditionPercentile?: number;
55-
/* The app version this alert was triggered for, can be omitted if the alert is for a network request (because the alert was checked against data from all versions of app) or a web app (where the app is versionless) */
55+
/** The app version this alert was triggered for, can be omitted if the alert is for a network request (because the alert was checked against data from all versions of app) or a web app (where the app is versionless) */
5656
appVersion?: string;
57-
/* The value that violated the alert condition (e.g. "76.5", "3") */
57+
/** The value that violated the alert condition (e.g. "76.5", "3") */
5858
violationValue: number;
59-
/* The unit for the violation value (e.g. "percent", "seconds") */
59+
/** The unit for the violation value (e.g. "percent", "seconds") */
6060
violationUnit: string;
61-
/* The link to Fireconsole to investigate more into this alert */
61+
/** The link to Fireconsole to investigate more into this alert */
6262
investigateUri: string;
6363
}
6464

@@ -80,7 +80,7 @@ export const thresholdAlert = 'performance.threshold';
8080
* Configuration for app distribution functions.
8181
*/
8282
export interface PerformanceOptions extends EventHandlerOptions {
83-
// Scope the function to trigger on a specific application.
83+
/** Scope the function to trigger on a specific application. */
8484
appId?: string;
8585
}
8686

0 commit comments

Comments
 (0)