Skip to content

Commit 7e46719

Browse files
docs: Improve readability of headings for functions. (#7869)
1 parent 4293fff commit 7e46719

File tree

77 files changed

+1176
-952
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+1176
-952
lines changed

docs-devsite/analytics.md

Lines changed: 82 additions & 70 deletions
Large diffs are not rendered by default.

docs-devsite/app-check.customprovider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Constructs a new instance of the `CustomProvider` class
3535
constructor(_customProviderOptions: CustomProviderOptions);
3636
```
3737
38-
### Parameters
38+
#### Parameters
3939
4040
| Parameter | Type | Description |
4141
| --- | --- | --- |

docs-devsite/app-check.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Prov
1818

1919
| Function | Description |
2020
| --- | --- |
21-
| <b>function(app...)</b> |
21+
| <b>function(app, ...)</b> |
2222
| [initializeAppCheck(app, options)](./app-check.md#initializeappcheck_5548dfc) | Activate App Check for the given app. Can be called only once per app. |
23-
| <b>function(appCheckInstance...)</b> |
23+
| <b>function(appCheckInstance, ...)</b> |
2424
| [getLimitedUseToken(appCheckInstance)](./app-check.md#getlimitedusetoken_53ef5e3) | Requests a Firebase App Check token. This method should be used only if you need to authorize requests to a non-Firebase backend.<!-- -->Returns limited-use tokens that are intended for use with your non-Firebase backend endpoints that are protected with <a href="https://firebase.google.com/docs/app-check/custom-resource-backend#replay-protection"> Replay Protection</a>. This method does not affect the token generation behavior of the \#getAppCheckToken() method. |
2525
| [getToken(appCheckInstance, forceRefresh)](./app-check.md#gettoken_39fc1b3) | Get the current App Check token. Attaches to the most recent in-flight request if one is present. Returns null if no token is present and no token requests are in-flight. |
2626
| [onTokenChanged(appCheckInstance, observer)](./app-check.md#ontokenchanged_9761e16) | Registers a listener to changes in the token state. There can be more than one listener registered at the same time for one or more App Check instances. The listeners call back on the UI thread whenever the current token associated with this App Check instance changes. |
@@ -51,7 +51,9 @@ Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Prov
5151
| --- | --- |
5252
| [AppCheckTokenListener](./app-check.md#appchecktokenlistener) | A listener that is called whenever the App Check token changes. |
5353

54-
## initializeAppCheck() {:#initializeappcheck_5548dfc}
54+
## function(app, ...)
55+
56+
### initializeAppCheck(app, options) {:#initializeappcheck_5548dfc}
5557

5658
Activate App Check for the given app. Can be called only once per app.
5759

@@ -61,7 +63,7 @@ Activate App Check for the given app. Can be called only once per app.
6163
export declare function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck;
6264
```
6365

64-
### Parameters
66+
#### Parameters
6567

6668
| Parameter | Type | Description |
6769
| --- | --- | --- |
@@ -72,7 +74,9 @@ export declare function initializeAppCheck(app: FirebaseApp | undefined, options
7274

7375
[AppCheck](./app-check.appcheck.md#appcheck_interface)
7476

75-
## getLimitedUseToken() {:#getlimitedusetoken_53ef5e3}
77+
## function(appCheckInstance, ...)
78+
79+
### getLimitedUseToken(appCheckInstance) {:#getlimitedusetoken_53ef5e3}
7680

7781
Requests a Firebase App Check token. This method should be used only if you need to authorize requests to a non-Firebase backend.
7882

@@ -84,7 +88,7 @@ Returns limited-use tokens that are intended for use with your non-Firebase back
8488
export declare function getLimitedUseToken(appCheckInstance: AppCheck): Promise<AppCheckTokenResult>;
8589
```
8690

87-
### Parameters
91+
#### Parameters
8892

8993
| Parameter | Type | Description |
9094
| --- | --- | --- |
@@ -96,7 +100,7 @@ Promise&lt;[AppCheckTokenResult](./app-check.appchecktokenresult.md#appchecktoke
96100

97101
The limited use token.
98102

99-
## getToken() {:#gettoken_39fc1b3}
103+
### getToken(appCheckInstance, forceRefresh) {:#gettoken_39fc1b3}
100104

101105
Get the current App Check token. Attaches to the most recent in-flight request if one is present. Returns null if no token is present and no token requests are in-flight.
102106

@@ -106,7 +110,7 @@ Get the current App Check token. Attaches to the most recent in-flight request i
106110
export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>;
107111
```
108112

109-
### Parameters
113+
#### Parameters
110114

111115
| Parameter | Type | Description |
112116
| --- | --- | --- |
@@ -117,7 +121,7 @@ export declare function getToken(appCheckInstance: AppCheck, forceRefresh?: bool
117121

118122
Promise&lt;[AppCheckTokenResult](./app-check.appchecktokenresult.md#appchecktokenresult_interface)<!-- -->&gt;
119123

120-
## onTokenChanged() {:#ontokenchanged_9761e16}
124+
### onTokenChanged(appCheckInstance, observer) {:#ontokenchanged_9761e16}
121125

122126
Registers a listener to changes in the token state. There can be more than one listener registered at the same time for one or more App Check instances. The listeners call back on the UI thread whenever the current token associated with this App Check instance changes.
123127

@@ -127,7 +131,7 @@ Registers a listener to changes in the token state. There can be more than one l
127131
export declare function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe;
128132
```
129133

130-
### Parameters
134+
#### Parameters
131135

132136
| Parameter | Type | Description |
133137
| --- | --- | --- |
@@ -140,7 +144,7 @@ export declare function onTokenChanged(appCheckInstance: AppCheck, observer: Par
140144

141145
A function that unsubscribes this listener.
142146

143-
## onTokenChanged() {:#ontokenchanged_8ef80a7}
147+
### onTokenChanged(appCheckInstance, onNext, onError, onCompletion) {:#ontokenchanged_8ef80a7}
144148

145149
Registers a listener to changes in the token state. There can be more than one listener registered at the same time for one or more App Check instances. The listeners call back on the UI thread whenever the current token associated with this App Check instance changes.
146150

@@ -150,7 +154,7 @@ Registers a listener to changes in the token state. There can be more than one l
150154
export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe;
151155
```
152156

153-
### Parameters
157+
#### Parameters
154158

155159
| Parameter | Type | Description |
156160
| --- | --- | --- |
@@ -165,7 +169,7 @@ export declare function onTokenChanged(appCheckInstance: AppCheck, onNext: (toke
165169

166170
A function that unsubscribes this listener.
167171

168-
## setTokenAutoRefreshEnabled() {:#settokenautorefreshenabled_057a76c}
172+
### setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) {:#settokenautorefreshenabled_057a76c}
169173

170174
Set whether App Check will automatically refresh tokens as needed.
171175

@@ -175,7 +179,7 @@ Set whether App Check will automatically refresh tokens as needed.
175179
export declare function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void;
176180
```
177181

178-
### Parameters
182+
#### Parameters
179183

180184
| Parameter | Type | Description |
181185
| --- | --- | --- |

docs-devsite/app-check.recaptchaenterpriseprovider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Create a ReCaptchaEnterpriseProvider instance.
3535
constructor(_siteKey: string);
3636
```
3737
38-
### Parameters
38+
#### Parameters
3939
4040
| Parameter | Type | Description |
4141
| --- | --- | --- |

docs-devsite/app-check.recaptchav3provider.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Create a ReCaptchaV3Provider instance.
3535
constructor(_siteKey: string);
3636
```
3737
38-
### Parameters
38+
#### Parameters
3939
4040
| Parameter | Type | Description |
4141
| --- | --- | --- |

docs-devsite/app.md

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ This package coordinates the communication between the different Firebase compon
1818

1919
| Function | Description |
2020
| --- | --- |
21-
| <b>function(app...)</b> |
21+
| <b>function(app, ...)</b> |
2222
| [deleteApp(app)](./app.md#deleteapp_cf608e1) | Renders this app unusable and frees the resources of all associated services. |
2323
| <b>function()</b> |
2424
| [getApps()](./app.md#getapps) | A (read-only) array of all initialized apps. |
2525
| [initializeApp()](./app.md#initializeapp) | Creates and initializes a FirebaseApp instance. |
26-
| <b>function(libraryKeyOrName...)</b> |
26+
| <b>function(libraryKeyOrName, ...)</b> |
2727
| [registerVersion(libraryKeyOrName, version, variant)](./app.md#registerversion_f673248) | Registers a library's name and version for platform logging purposes. |
28-
| <b>function(logCallback...)</b> |
28+
| <b>function(logCallback, ...)</b> |
2929
| [onLog(logCallback, options)](./app.md#onlog_fd46eae) | Sets log handler for all Firebase SDKs. |
30-
| <b>function(logLevel...)</b> |
30+
| <b>function(logLevel, ...)</b> |
3131
| [setLogLevel(logLevel)](./app.md#setloglevel_697d53a) | Sets log level for all Firebase SDKs.<!-- -->All of the log types above the current log level are captured (i.e. if you set the log level to <code>info</code>, errors are logged, but <code>debug</code> and <code>verbose</code> logs are not). |
32-
| <b>function(name...)</b> |
32+
| <b>function(name, ...)</b> |
3333
| [getApp(name)](./app.md#getapp_1eaaff4) | Retrieves a [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) instance.<!-- -->When called with no arguments, the default app is returned. When an app name is provided, the app corresponding to that name is returned.<!-- -->An exception is thrown if the app being retrieved has not yet been initialized. |
34-
| <b>function(options...)</b> |
34+
| <b>function(options, ...)</b> |
3535
| [initializeApp(options, name)](./app.md#initializeapp_cb2f5e1) | Creates and initializes a [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) instance.<!-- -->See [Add Firebase to your app](https://firebase.google.com/docs/web/setup#add_firebase_to_your_app) and [Initialize multiple projects](https://firebase.google.com/docs/web/setup#multiple-projects) for detailed documentation. |
3636
| [initializeApp(options, config)](./app.md#initializeapp_079e917) | Creates and initializes a FirebaseApp instance. |
3737

@@ -49,7 +49,9 @@ This package coordinates the communication between the different Firebase compon
4949
| --- | --- |
5050
| [SDK\_VERSION](./app.md#sdk_version) | The current SDK version. |
5151

52-
## deleteApp() {:#deleteapp_cf608e1}
52+
## function(app, ...)
53+
54+
### deleteApp(app) {:#deleteapp_cf608e1}
5355

5456
Renders this app unusable and frees the resources of all associated services.
5557

@@ -59,7 +61,7 @@ Renders this app unusable and frees the resources of all associated services.
5961
export declare function deleteApp(app: FirebaseApp): Promise<void>;
6062
```
6163

62-
### Parameters
64+
#### Parameters
6365

6466
| Parameter | Type | Description |
6567
| --- | --- | --- |
@@ -83,7 +85,9 @@ deleteApp(app)
8385

8486
```
8587

86-
## getApps() {:#getapps}
88+
## function()
89+
90+
### getApps() {:#getapps}
8791

8892
A (read-only) array of all initialized apps.
8993

@@ -96,7 +100,7 @@ export declare function getApps(): FirebaseApp[];
96100

97101
[FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->\[\]
98102

99-
## initializeApp() {:#initializeapp}
103+
### initializeApp() {:#initializeapp}
100104

101105
Creates and initializes a FirebaseApp instance.
102106

@@ -109,7 +113,9 @@ export declare function initializeApp(): FirebaseApp;
109113

110114
[FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)
111115

112-
## registerVersion() {:#registerversion_f673248}
116+
## function(libraryKeyOrName, ...)
117+
118+
### registerVersion(libraryKeyOrName, version, variant) {:#registerversion_f673248}
113119

114120
Registers a library's name and version for platform logging purposes.
115121

@@ -119,7 +125,7 @@ Registers a library's name and version for platform logging purposes.
119125
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
120126
```
121127

122-
### Parameters
128+
#### Parameters
123129

124130
| Parameter | Type | Description |
125131
| --- | --- | --- |
@@ -131,7 +137,9 @@ export declare function registerVersion(libraryKeyOrName: string, version: strin
131137

132138
void
133139

134-
## onLog() {:#onlog_fd46eae}
140+
## function(logCallback, ...)
141+
142+
### onLog(logCallback, options) {:#onlog_fd46eae}
135143

136144
Sets log handler for all Firebase SDKs.
137145

@@ -141,7 +149,7 @@ Sets log handler for all Firebase SDKs.
141149
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
142150
```
143151

144-
### Parameters
152+
#### Parameters
145153

146154
| Parameter | Type | Description |
147155
| --- | --- | --- |
@@ -152,7 +160,9 @@ export declare function onLog(logCallback: LogCallback | null, options?: LogOpti
152160

153161
void
154162

155-
## setLogLevel() {:#setloglevel_697d53a}
163+
## function(logLevel, ...)
164+
165+
### setLogLevel(logLevel) {:#setloglevel_697d53a}
156166

157167
Sets log level for all Firebase SDKs.
158168

@@ -164,7 +174,7 @@ All of the log types above the current log level are captured (i.e. if you set t
164174
export declare function setLogLevel(logLevel: LogLevelString): void;
165175
```
166176

167-
### Parameters
177+
#### Parameters
168178

169179
| Parameter | Type | Description |
170180
| --- | --- | --- |
@@ -174,7 +184,9 @@ export declare function setLogLevel(logLevel: LogLevelString): void;
174184

175185
void
176186

177-
## getApp() {:#getapp_1eaaff4}
187+
## function(name, ...)
188+
189+
### getApp(name) {:#getapp_1eaaff4}
178190

179191
Retrieves a [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) instance.
180192

@@ -188,7 +200,7 @@ An exception is thrown if the app being retrieved has not yet been initialized.
188200
export declare function getApp(name?: string): FirebaseApp;
189201
```
190202

191-
### Parameters
203+
#### Parameters
192204

193205
| Parameter | Type | Description |
194206
| --- | --- | --- |
@@ -218,7 +230,9 @@ const otherApp = getApp("otherApp");
218230

219231
```
220232

221-
## initializeApp() {:#initializeapp_cb2f5e1}
233+
## function(options, ...)
234+
235+
### initializeApp(options, name) {:#initializeapp_cb2f5e1}
222236

223237
Creates and initializes a [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) instance.
224238

@@ -230,7 +244,7 @@ See [Add Firebase to your app](https://firebase.google.com/docs/web/setup#add_fi
230244
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
231245
```
232246

233-
### Parameters
247+
#### Parameters
234248

235249
| Parameter | Type | Description |
236250
| --- | --- | --- |
@@ -274,7 +288,7 @@ const otherApp = initializeApp({
274288

275289
```
276290

277-
## initializeApp() {:#initializeapp_079e917}
291+
### initializeApp(options, config) {:#initializeapp_079e917}
278292

279293
Creates and initializes a FirebaseApp instance.
280294

@@ -284,7 +298,7 @@ Creates and initializes a FirebaseApp instance.
284298
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
285299
```
286300

287-
### Parameters
301+
#### Parameters
288302

289303
| Parameter | Type | Description |
290304
| --- | --- | --- |

docs-devsite/auth.actioncodeurl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Parses the email action link string and returns an [ActionCodeURL](./auth.action
107107
static parseLink(link: string): ActionCodeURL | null;
108108
```
109109

110-
### Parameters
110+
#### Parameters
111111

112112
| Parameter | Type | Description |
113113
| --- | --- | --- |

docs-devsite/auth.auth.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Adds a blocking callback that runs before an auth state change sets a new user.
168168
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
169169
```
170170

171-
### Parameters
171+
#### Parameters
172172

173173
| Parameter | Type | Description |
174174
| --- | --- | --- |
@@ -191,7 +191,7 @@ To keep the old behavior, see [Auth.onIdTokenChanged()](./auth.auth.md#authonidt
191191
onAuthStateChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
192192
```
193193

194-
### Parameters
194+
#### Parameters
195195

196196
| Parameter | Type | Description |
197197
| --- | --- | --- |
@@ -215,7 +215,7 @@ This includes sign-in, sign-out, and token refresh events.
215215
onIdTokenChanged(nextOrObserver: NextOrObserver<User | null>, error?: ErrorFn, completed?: CompleteFn): Unsubscribe;
216216
```
217217

218-
### Parameters
218+
#### Parameters
219219

220220
| Parameter | Type | Description |
221221
| --- | --- | --- |
@@ -243,7 +243,7 @@ This method does not work in a Node.js environment.
243243
setPersistence(persistence: Persistence): Promise<void>;
244244
```
245245

246-
### Parameters
246+
#### Parameters
247247

248248
| Parameter | Type | Description |
249249
| --- | --- | --- |
@@ -290,7 +290,7 @@ The operation fails with an error if the user to be updated belongs to a differe
290290
updateCurrentUser(user: User | null): Promise<void>;
291291
```
292292

293-
### Parameters
293+
#### Parameters
294294

295295
| Parameter | Type | Description |
296296
| --- | --- | --- |

docs-devsite/auth.confirmationresult.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Finishes a phone number sign-in, link, or reauthentication.
5252
confirm(verificationCode: string): Promise<UserCredential>;
5353
```
5454

55-
### Parameters
55+
#### Parameters
5656

5757
| Parameter | Type | Description |
5858
| --- | --- | --- |

0 commit comments

Comments
 (0)