Skip to content

Commit c6076eb

Browse files
hsubox76Feiyang1
hsubox76
and
Feiyang1
authored
Add app property to public typings of all services (#5351)
* Add app property to typings of all services * Update packages/storage/src/public-types.ts Co-authored-by: Feiyang <[email protected]> Co-authored-by: Feiyang <[email protected]>
1 parent 0b95a51 commit c6076eb

File tree

12 files changed

+349
-313
lines changed

12 files changed

+349
-313
lines changed

‎common/api-review/auth.api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ export function applyActionCode(auth: Auth, oobCode: string): Promise<void>;
8080

8181
// @public
8282
export interface Auth {
83+
readonly app: FirebaseApp;
8384
readonly config: Config;
8485
readonly currentUser: User | null;
8586
readonly emulatorConfig: EmulatorConfig | null;

‎common/api-review/installations.api.md

Lines changed: 42 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,42 @@
1-
## API Report File for "@firebase/installations"
2-
3-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4-
5-
```ts
6-
7-
import { FirebaseApp } from '@firebase/app';
8-
9-
// @public
10-
export function deleteInstallations(installations: Installations): Promise<void>;
11-
12-
// @internal
13-
export interface _FirebaseInstallationsInternal {
14-
getId(): Promise<string>;
15-
getToken(forceRefresh?: boolean): Promise<string>;
16-
}
17-
18-
// @public
19-
export function getId(installations: Installations): Promise<string>;
20-
21-
// @public
22-
export function getInstallations(app?: FirebaseApp): Installations;
23-
24-
// @public
25-
export function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
26-
27-
// @public
28-
export type IdChangeCallbackFn = (installationId: string) => void;
29-
30-
// @public
31-
export type IdChangeUnsubscribeFn = () => void;
32-
33-
// @public
34-
export interface Installations {
35-
}
36-
37-
// @public
38-
export function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
39-
40-
41-
```
1+
## API Report File for "@firebase/installations"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { FirebaseApp } from '@firebase/app';
8+
9+
// @public
10+
export function deleteInstallations(installations: Installations): Promise<void>;
11+
12+
// @internal
13+
export interface _FirebaseInstallationsInternal {
14+
getId(): Promise<string>;
15+
getToken(forceRefresh?: boolean): Promise<string>;
16+
}
17+
18+
// @public
19+
export function getId(installations: Installations): Promise<string>;
20+
21+
// @public
22+
export function getInstallations(app?: FirebaseApp): Installations;
23+
24+
// @public
25+
export function getToken(installations: Installations, forceRefresh?: boolean): Promise<string>;
26+
27+
// @public
28+
export type IdChangeCallbackFn = (installationId: string) => void;
29+
30+
// @public
31+
export type IdChangeUnsubscribeFn = () => void;
32+
33+
// @public
34+
export interface Installations {
35+
app: FirebaseApp;
36+
}
37+
38+
// @public
39+
export function onIdChange(installations: Installations, callback: IdChangeCallbackFn): IdChangeUnsubscribeFn;
40+
41+
42+
```

‎common/api-review/messaging-sw.api.md

Lines changed: 69 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,69 @@
1-
## API Report File for "@firebase/messaging-sw"
2-
3-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4-
5-
```ts
6-
7-
import { FirebaseApp } from '@firebase/app';
8-
import { NextFn } from '@firebase/util';
9-
import { Observer } from '@firebase/util';
10-
import { Unsubscribe } from '@firebase/util';
11-
12-
// @public
13-
export function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
14-
15-
// @public
16-
export interface FcmOptions {
17-
analyticsLabel?: string;
18-
link?: string;
19-
}
20-
21-
// @public
22-
export function getMessaging(app?: FirebaseApp): Messaging;
23-
24-
// @public
25-
export interface GetTokenOptions {
26-
serviceWorkerRegistration?: ServiceWorkerRegistration;
27-
vapidKey?: string;
28-
}
29-
30-
// @public
31-
export function isSupported(): Promise<boolean>;
32-
33-
// @public
34-
export interface MessagePayload {
35-
collapseKey: string;
36-
data?: {
37-
[key: string]: string;
38-
};
39-
fcmOptions?: FcmOptions;
40-
from: string;
41-
messageId: string;
42-
notification?: NotificationPayload;
43-
}
44-
45-
// @public
46-
export interface Messaging {
47-
}
48-
49-
export { NextFn }
50-
51-
// @public
52-
export interface NotificationPayload {
53-
body?: string;
54-
image?: string;
55-
title?: string;
56-
}
57-
58-
export { Observer }
59-
60-
// @public
61-
export function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
62-
63-
export { Unsubscribe }
64-
65-
66-
// (No @packageDocumentation comment for this package)
67-
68-
```
1+
## API Report File for "@firebase/messaging-sw"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { FirebaseApp } from '@firebase/app';
8+
import { NextFn } from '@firebase/util';
9+
import { Observer } from '@firebase/util';
10+
import { Unsubscribe } from '@firebase/util';
11+
12+
// @public
13+
export function experimentalSetDeliveryMetricsExportedToBigQueryEnabled(messaging: Messaging, enable: boolean): void;
14+
15+
// @public
16+
export interface FcmOptions {
17+
analyticsLabel?: string;
18+
link?: string;
19+
}
20+
21+
// @public
22+
export function getMessaging(app?: FirebaseApp): Messaging;
23+
24+
// @public
25+
export interface GetTokenOptions {
26+
serviceWorkerRegistration?: ServiceWorkerRegistration;
27+
vapidKey?: string;
28+
}
29+
30+
// @public
31+
export function isSupported(): Promise<boolean>;
32+
33+
// @public
34+
export interface MessagePayload {
35+
collapseKey: string;
36+
data?: {
37+
[key: string]: string;
38+
};
39+
fcmOptions?: FcmOptions;
40+
from: string;
41+
messageId: string;
42+
notification?: NotificationPayload;
43+
}
44+
45+
// @public
46+
export interface Messaging {
47+
app: FirebaseApp;
48+
}
49+
50+
export { NextFn }
51+
52+
// @public
53+
export interface NotificationPayload {
54+
body?: string;
55+
image?: string;
56+
title?: string;
57+
}
58+
59+
export { Observer }
60+
61+
// @public
62+
export function onBackgroundMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
63+
64+
export { Unsubscribe }
65+
66+
67+
// (No @packageDocumentation comment for this package)
68+
69+
```

‎common/api-review/messaging.api.md

Lines changed: 70 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,70 @@
1-
## API Report File for "@firebase/messaging"
2-
3-
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4-
5-
```ts
6-
7-
import { FirebaseApp } from '@firebase/app';
8-
import { NextFn } from '@firebase/util';
9-
import { Observer } from '@firebase/util';
10-
import { Unsubscribe } from '@firebase/util';
11-
12-
// @public
13-
export function deleteToken(messaging: Messaging): Promise<boolean>;
14-
15-
// @public
16-
export interface FcmOptions {
17-
analyticsLabel?: string;
18-
link?: string;
19-
}
20-
21-
// @public
22-
export function getMessaging(app?: FirebaseApp): Messaging;
23-
24-
// @public
25-
export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
26-
27-
// @public
28-
export interface GetTokenOptions {
29-
serviceWorkerRegistration?: ServiceWorkerRegistration;
30-
vapidKey?: string;
31-
}
32-
33-
// @public
34-
export function isSupported(): Promise<boolean>;
35-
36-
// @public
37-
export interface MessagePayload {
38-
collapseKey: string;
39-
data?: {
40-
[key: string]: string;
41-
};
42-
fcmOptions?: FcmOptions;
43-
from: string;
44-
messageId: string;
45-
notification?: NotificationPayload;
46-
}
47-
48-
// @public
49-
export interface Messaging {
50-
}
51-
52-
export { NextFn }
53-
54-
// @public
55-
export interface NotificationPayload {
56-
body?: string;
57-
image?: string;
58-
title?: string;
59-
}
60-
61-
export { Observer }
62-
63-
// @public
64-
export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
65-
66-
export { Unsubscribe }
67-
68-
69-
```
1+
## API Report File for "@firebase/messaging"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { FirebaseApp } from '@firebase/app';
8+
import { NextFn } from '@firebase/util';
9+
import { Observer } from '@firebase/util';
10+
import { Unsubscribe } from '@firebase/util';
11+
12+
// @public
13+
export function deleteToken(messaging: Messaging): Promise<boolean>;
14+
15+
// @public
16+
export interface FcmOptions {
17+
analyticsLabel?: string;
18+
link?: string;
19+
}
20+
21+
// @public
22+
export function getMessaging(app?: FirebaseApp): Messaging;
23+
24+
// @public
25+
export function getToken(messaging: Messaging, options?: GetTokenOptions): Promise<string>;
26+
27+
// @public
28+
export interface GetTokenOptions {
29+
serviceWorkerRegistration?: ServiceWorkerRegistration;
30+
vapidKey?: string;
31+
}
32+
33+
// @public
34+
export function isSupported(): Promise<boolean>;
35+
36+
// @public
37+
export interface MessagePayload {
38+
collapseKey: string;
39+
data?: {
40+
[key: string]: string;
41+
};
42+
fcmOptions?: FcmOptions;
43+
from: string;
44+
messageId: string;
45+
notification?: NotificationPayload;
46+
}
47+
48+
// @public
49+
export interface Messaging {
50+
app: FirebaseApp;
51+
}
52+
53+
export { NextFn }
54+
55+
// @public
56+
export interface NotificationPayload {
57+
body?: string;
58+
image?: string;
59+
title?: string;
60+
}
61+
62+
export { Observer }
63+
64+
// @public
65+
export function onMessage(messaging: Messaging, nextOrObserver: NextFn<MessagePayload> | Observer<MessagePayload>): Unsubscribe;
66+
67+
export { Unsubscribe }
68+
69+
70+
```

0 commit comments

Comments
 (0)