Skip to content

Commit

Permalink
fix tsdoc comments (#1240)
Browse files Browse the repository at this point in the history
  • Loading branch information
colerogers authored Sep 21, 2022
1 parent bd0fcbc commit 1ac04ad
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 12 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- Fix reference docs for performance monitoring.
24 changes: 12 additions & 12 deletions src/v2/providers/alerts/performance.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,27 +38,27 @@ import {
* Payload is wrapped inside a {@link FirebaseAlertData} object.
*/
export interface ThresholdAlertPayload {
/* Name of the trace or network request this alert is for (e.g. my_custom_trace, firebase.com/api/123) */
/** Name of the trace or network request this alert is for (e.g. my_custom_trace, firebase.com/api/123) */
eventName: string;
/* The resource type this alert is for (i.e. trace, network request, screen rendering, etc.) */
/** The resource type this alert is for (i.e. trace, network request, screen rendering, etc.) */
eventType: string;
/* The metric type this alert is for (i.e. success rate, response time, duration, etc.) */
/** The metric type this alert is for (i.e. success rate, response time, duration, etc.) */
metricType: string;
/* The number of events checked for this alert condition */
/** The number of events checked for this alert condition */
numSamples: number;
/* The threshold value of the alert condition without units (e.g. "75", "2.1") */
/** The threshold value of the alert condition without units (e.g. "75", "2.1") */
thresholdValue: number;
/* The unit for the alert threshold (e.g. "percent", "seconds") */
/** The unit for the alert threshold (e.g. "percent", "seconds") */
thresholdUnit: string;
/* The percentile of the alert condition, can be 0 if percentile is not applicable to the alert condition and omitted; range: [1, 100] */
/** The percentile of the alert condition, can be 0 if percentile is not applicable to the alert condition and omitted; range: [1, 100] */
conditionPercentile?: number;
/* 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) */
/** 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) */
appVersion?: string;
/* The value that violated the alert condition (e.g. "76.5", "3") */
/** The value that violated the alert condition (e.g. "76.5", "3") */
violationValue: number;
/* The unit for the violation value (e.g. "percent", "seconds") */
/** The unit for the violation value (e.g. "percent", "seconds") */
violationUnit: string;
/* The link to Fireconsole to investigate more into this alert */
/** The link to Fireconsole to investigate more into this alert */
investigateUri: string;
}

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

Expand Down

0 comments on commit 1ac04ad

Please sign in to comment.