Skip to content

Commit 6f84af3

Browse files
Feiyang1Feiyang1
committed
address comments2
1 parent 0f9c84f commit 6f84af3

File tree

7 files changed

+21
-21
lines changed

7 files changed

+21
-21
lines changed

‎packages-exp/installations-exp/src/api/delete-installations.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { FirebaseInstallations } from '../interfaces/public-types';
2424

2525
/**
2626
* Deletes the Firebase Installation and all associated data.
27-
* @param installations - The Installations instance.
27+
* @param installations - The `Installations` instance.
2828
*
2929
* @public
3030
*/

‎packages-exp/installations-exp/src/api/get-id.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ import { FirebaseInstallations } from '../interfaces/public-types';
2323
/**
2424
* Creates a Firebase Installation if there isn't one for the app and
2525
* returns the Installation ID.
26-
* @param installations - The Installations instance.
26+
* @param installations - The `Installations` instance.
2727
*
2828
* @public
2929
*/

‎packages-exp/installations-exp/src/api/get-installations.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { FirebaseInstallations } from '../interfaces/public-types';
2020

2121
/**
2222
* Returns an instance of FirebaseInstallations associated with the given FirebaseApp instance.
23-
* @param app - The FirebaseApp instance.
23+
* @param app - The `FirebaseApp` instance.
2424
*
2525
* @public
2626
*/

‎packages-exp/installations-exp/src/api/get-token.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { FirebaseInstallations } from '../interfaces/public-types';
2525

2626
/**
2727
* Returns an Installation auth token, identifying the current Firebase Installation.
28-
* @param installations - The Installations instance.
28+
* @param installations - The `Installations` instance.
2929
* @param forceRefresh - Force refresh regardless of token expiration.
3030
*
3131
* @public

‎packages-exp/installations-exp/src/api/on-id-change.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export type IdChangeUnsubscribeFn = () => void;
3535
/**
3636
* Sets a new callback that will get called when Installation ID changes.
3737
* Returns an unsubscribe function that will remove the callback when called.
38-
* @param installations - The Installations instance.
38+
* @param installations - The `Installations` instance.
3939
* @param callback - The callback function that is invoked when FID changes.
4040
* @returns A function that can be called to unsubscribe.
4141
*

‎packages-exp/performance-exp/src/index.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ const DEFAULT_ENTRY_NAME = '[DEFAULT]';
5151

5252
/**
5353
* Returns a FirebasePerformance instance for the given app.
54-
* @param app - The FirebaseApp to use.
54+
* @param app - The `FirebaseApp` to use.
5555
* @public
5656
*/
5757
export function getPerformance(
@@ -65,8 +65,8 @@ export function getPerformance(
6565

6666
/**
6767
* Returns a FirebasePerformance instance for the given app. Can only be called once.
68-
* @param app - The FirebaseApp to use.
69-
* @param settings - Optional settings for the Performance instance.
68+
* @param app - The `FirebaseApp` to use.
69+
* @param settings - Optional settings for the `FirebasePerformance` instance.
7070
* @public
7171
*/
7272
export function initializePerformance(
@@ -89,8 +89,8 @@ export function initializePerformance(
8989
}
9090

9191
/**
92-
* Returns a new PerformanceTrace instance.
93-
* @param performance - The FirebasePerformance instance to use.
92+
* Returns a new `PerformanceTrace` instance.
93+
* @param performance - The `FirebasePerformance` instance to use.
9494
* @param name - The name of the trace.
9595
* @public
9696
*/

‎packages-exp/remote-config-exp/src/api.ts

+11-11
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ import { getModularInstance } from '@firebase/util';
3131

3232
/**
3333
*
34-
* @param app - The Firebase App instance.
35-
* @returns A Remote Config instance.
34+
* @param app - The `FirebaseApp` instance.
35+
* @returns A `RemoteConfig` instance.
3636
*
3737
* @public
3838
*/
@@ -44,7 +44,7 @@ export function getRemoteConfig(app: FirebaseApp = getApp()): RemoteConfig {
4444

4545
/**
4646
* Makes the last fetched config available to the getters.
47-
* @param remoteConfig - The Remote Config instance.
47+
* @param remoteConfig - The `RemoteConfig` instance.
4848
* @returns A promise which resolves to true if the current call activated the fetched configs.
4949
* If the fetched configs were already activated, the promise will resolve to false.
5050
*
@@ -75,7 +75,7 @@ export async function activate(remoteConfig: RemoteConfig): Promise<boolean> {
7575

7676
/**
7777
* Ensures the last activated config are available to the getters.
78-
* @param remoteConfig - The Remote Config instance.
78+
* @param remoteConfig - The `RemoteConfig` instance.
7979
*
8080
* @returns A promise that resolves when the last activated config is available to the getters.
8181
* @public
@@ -92,7 +92,7 @@ export function ensureInitialized(remoteConfig: RemoteConfig): Promise<void> {
9292

9393
/**
9494
* Fetches and caches configuration from the Remote Config service.
95-
* @param remoteConfig - The Remote Config instance.
95+
* @param remoteConfig - The `RemoteConfig` instance.
9696
* @public
9797
*/
9898
export async function fetchConfig(remoteConfig: RemoteConfig): Promise<void> {
@@ -134,7 +134,7 @@ export async function fetchConfig(remoteConfig: RemoteConfig): Promise<void> {
134134
/**
135135
* Gets all config.
136136
*
137-
* @param remoteConfig - The Remote Config instance.
137+
* @param remoteConfig - The `RemoteConfig` instance.
138138
* @returns All config.
139139
*
140140
* @public
@@ -155,7 +155,7 @@ export function getAll(remoteConfig: RemoteConfig): Record<string, Value> {
155155
*
156156
* Convenience method for calling <code>remoteConfig.getValue(key).asBoolean()</code>.
157157
*
158-
* @param remoteConfig - The Remote Config instance.
158+
* @param remoteConfig - The `RemoteConfig` instance.
159159
* @param key - The name of the parameter.
160160
*
161161
* @returns The value for the given key as a boolean.
@@ -170,7 +170,7 @@ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean {
170170
*
171171
* Convenience method for calling <code>remoteConfig.getValue(key).asNumber()</code>.
172172
*
173-
* @param remoteConfig - The Remote Config instance.
173+
* @param remoteConfig - The `RemoteConfig` instance.
174174
* @param key - The name of the parameter.
175175
*
176176
* @returns The value for the given key as a number.
@@ -185,7 +185,7 @@ export function getNumber(remoteConfig: RemoteConfig, key: string): number {
185185
* Gets the value for the given key as a string.
186186
* Convenience method for calling <code>remoteConfig.getValue(key).asString()</code>.
187187
*
188-
* @param remoteConfig - The Remote Config instance.
188+
* @param remoteConfig - The `RemoteConfig` instance.
189189
* @param key - The name of the parameter.
190190
*
191191
* @returns The value for the given key as a string.
@@ -199,7 +199,7 @@ export function getString(remoteConfig: RemoteConfig, key: string): string {
199199
/**
200200
* Gets the {@link @firebase/remote-config-types#Value} for the given key.
201201
*
202-
* @param remoteConfig - The Remote Config instance.
202+
* @param remoteConfig - The `RemoteConfig` instance.
203203
* @param key - The name of the parameter.
204204
*
205205
* @returns The value for the given key.
@@ -230,7 +230,7 @@ export function getValue(remoteConfig: RemoteConfig, key: string): Value {
230230
/**
231231
* Defines the log level to use.
232232
*
233-
* @param remoteConfig - The Remote Config instance.
233+
* @param remoteConfig - The `RemoteConfig` instance.
234234
* @param logLevel - The log level to set.
235235
*
236236
* @public

0 commit comments

Comments
 (0)