Skip to content

Commit 74d6cca

Browse files
committed
Adding some style, formatting, and link fixes.
1 parent b58a617 commit 74d6cca

File tree

3 files changed

+14
-14
lines changed

3 files changed

+14
-14
lines changed

packages/firebase/compat/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7484,7 +7484,7 @@ declare namespace firebase.messaging {
74847484
* @param options.serviceWorkerRegistration The service worker registration for receiving push
74857485
* messaging. If the registration is not provided explicitly, you need to have a
74867486
* `firebase-messaging-sw.js` at your root location. See
7487-
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token Retrieve the current registration token}
7487+
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
74887488
* for more details.
74897489
*
74907490
* @return The promise resolves with an FCM registration token.

packages/messaging/src/api.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,15 @@ export function getMessagingInSw(app: FirebaseApp = getApp()): Messaging {
9292
}
9393

9494
/**
95-
* Subscribes the {@link Messaging} instance to push notifications. Returns an Firebase Cloud
95+
* Subscribes the {@link Messaging} instance to push notifications. Returns a Firebase Cloud
9696
* Messaging registration token that can be used to send push messages to that {@link Messaging}
9797
* instance.
9898
*
99-
* If a notification permission isn't already granted, this method asks the user for permission. The
99+
* If notification permission isn't already granted, this method asks the user for permission. The
100100
* returned promise rejects if the user does not allow the app to show notifications.
101101
*
102102
* @param messaging - The {@link Messaging} instance.
103-
* @param options - Provides an optional vapid key and an optinoal service worker registration
103+
* @param options - Provides an optional vapid key and an optional service worker registration.
104104
*
105105
* @returns The promise resolves with an FCM registration token.
106106
*

packages/messaging/src/interfaces/public-types.ts

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
import { FirebaseApp } from '@firebase/app';
1919

2020
/**
21-
* Display notification details. They are sent through the
22-
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
21+
* Display notification details. Details are sent through the
22+
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
2323
*
2424
* @public
2525
*/
@@ -49,7 +49,7 @@ export interface NotificationPayload {
4949
/**
5050
* Options for features provided by the FCM SDK for Web. See {@link
5151
* https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#webpushfcmoptions |
52-
* WebpushFcmOptions}
52+
* WebpushFcmOptions}.
5353
*
5454
* @public
5555
*/
@@ -69,7 +69,7 @@ export interface FcmOptions {
6969
* Message payload that contains the notification payload that is represented with
7070
* {@link NotificationPayload} and the data payload that contains an arbitrary
7171
* number of key-value pairs sent by developers through the
72-
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}
72+
* {@link https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages#notification | Send API}.
7373
*
7474
* @public
7575
*/
@@ -101,24 +101,24 @@ export interface MessagePayload {
101101
collapseKey: string;
102102

103103
/**
104-
* The message id of a message.
104+
* The message ID of a message.
105105
*/
106106
messageId: string;
107107
}
108108

109109
/**
110-
* Options for {@link getToken}
110+
* Options for {@link getToken}.
111111
*
112112
* @public
113113
*/
114114
export interface GetTokenOptions {
115115
/**
116-
* The public server key provided to push services. It is used to
117-
* authenticate the push subscribers to receive push messages only from sending servers that hold
116+
* The public server key provided to push services. The key is used to
117+
* authenticate push subscribers to receive push messages only from sending servers that hold
118118
* the corresponding private key. If it is not provided, a default VAPID key is used. Note that some
119119
* push services (Chrome Push Service) require a non-default VAPID key. Therefore, it is recommended
120120
* to generate and import a VAPID key for your project with
121-
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_with_fcm | Configure Web Credentials with FCM}.
121+
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#configure_web_credentials_in_your_app | Configure Web Credentials with FCM}.
122122
* See
123123
* {@link https://developers.google.com/web/fundamentals/push-notifications/web-push-protocol | The Web Push Protocol}
124124
* for details on web push services.
@@ -128,7 +128,7 @@ export interface GetTokenOptions {
128128
* The service worker registration for receiving push
129129
* messaging. If the registration is not provided explicitly, you need to have a
130130
* `firebase-messaging-sw.js` at your root location. See
131-
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#retrieve-the-current-registration-token | Retrieve the current registration token}
131+
* {@link https://firebase.google.com/docs/cloud-messaging/js/client#access_the_registration_token | Access the registration token}
132132
* for more details.
133133
*/
134134
serviceWorkerRegistration?: ServiceWorkerRegistration;

0 commit comments

Comments
 (0)