Skip to content

Commit 5a14175

Browse files
authored
exporting interfaces and adding tsdoc comments (#1100)
1 parent 7432327 commit 5a14175

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

src/v2/providers/alerts/appDistribution.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,13 @@ import { FirebaseAlertData, getEndpointAnnotation } from './alerts';
88
*/
99
export interface NewTesterDevicePayload {
1010
['@type']: 'type.googleapis.com/google.events.firebase.firebasealerts.v1.AppDistroNewTesterIosDevicePayload';
11+
/** Name of the tester */
1112
testerName: string;
13+
/** Email of the tester */
1214
testerEmail: string;
15+
/** The device model name */
1316
testerDeviceModelName: string;
17+
/** The device ID */
1418
testerDeviceIdentifier: string;
1519
}
1620

src/v2/providers/alerts/crashlytics.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@ import { CloudEvent, CloudFunction } from '../../core';
33
import * as options from '../../options';
44

55
/** Generic crashlytics issue interface */
6-
interface Issue {
6+
export interface Issue {
7+
/** The ID of the crashlytics issue */
78
id: string;
9+
/** The title of the crashlytics issue */
810
title: string;
11+
/** The subtitle of the crashlytics issue */
912
subtitle: string;
13+
/** The application version of the crashlytics issue */
1014
appVersion: string;
1115
}
1216

@@ -48,7 +52,7 @@ export interface RegressionAlertPayload {
4852
}
4953

5054
/** Generic crashlytics trending issue interface */
51-
interface TrendingIssueDetails {
55+
export interface TrendingIssueDetails {
5256
/** The type of the Crashlytics issue, e.g. new fatal, new nonfatal, ANR */
5357
type: string;
5458
/** Basic information of the Crashlytics issue */

src/v2/providers/storage.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ export interface CustomerEncryption {
174174
keySha256?: string;
175175
}
176176

177+
/** A CloudEvent that contains StorageObjectData */
177178
export interface StorageEvent extends CloudEvent<StorageObjectData> {
178179
/** The name of the bucket containing this object. */
179180
bucket: string;

0 commit comments

Comments
 (0)