Skip to content

Commit 07a65d3

Browse files
Fix documentation links for function overloads and improve readability of function headings (#7864)
* Support function links to function overloads. * Improve readability of headings for functions.
1 parent 9d3896a commit 07a65d3

File tree

108 files changed

+1724
-1456
lines changed

Some content is hidden

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

108 files changed

+1724
-1456
lines changed

docs-devsite/analytics.md

Lines changed: 114 additions & 102 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: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Prov
1818

1919
| Function | Description |
2020
| --- | --- |
21-
| <b>function(app...)</b> |
22-
| [initializeAppCheck(app, options)](./app-check.md#initializeappcheck) | Activate App Check for the given app. Can be called only once per app. |
23-
| <b>function(appCheckInstance...)</b> |
24-
| [getLimitedUseToken(appCheckInstance)](./app-check.md#getlimitedusetoken) | 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. |
25-
| [getToken(appCheckInstance, forceRefresh)](./app-check.md#gettoken) | 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. |
26-
| [onTokenChanged(appCheckInstance, observer)](./app-check.md#ontokenchanged) | 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. |
27-
| [onTokenChanged(appCheckInstance, onNext, onError, onCompletion)](./app-check.md#ontokenchanged) | 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. |
28-
| [setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)](./app-check.md#settokenautorefreshenabled) | Set whether App Check will automatically refresh tokens as needed. |
21+
| <b>function(app, ...)</b> |
22+
| [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> |
24+
| [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. |
25+
| [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. |
26+
| [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. |
27+
| [onTokenChanged(appCheckInstance, onNext, onError, onCompletion)](./app-check.md#ontokenchanged_8ef80a7) | 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. |
28+
| [setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)](./app-check.md#settokenautorefreshenabled_057a76c) | Set whether App Check will automatically refresh tokens as needed. |
2929

3030
## Classes
3131

@@ -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()
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()
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()
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()
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()
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()
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.firebaseapp.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
1212
# FirebaseApp interface
1313
A [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) holds the initialization information for a collection of services.
1414

15-
Do not call this constructor directly. Instead, use [initializeApp()](./app.md#initializeapp) to create an app.
15+
Do not call this constructor directly. Instead, use [initializeApp()](./app.md#initializeapp_cb2f5e1) to create an app.
1616

1717
<b>Signature:</b>
1818

@@ -26,7 +26,7 @@ export interface FirebaseApp
2626
| --- | --- | --- |
2727
| [automaticDataCollectionEnabled](./app.firebaseapp.md#firebaseappautomaticdatacollectionenabled) | boolean | The settable config flag for GDPR opt-in/opt-out |
2828
| [name](./app.firebaseapp.md#firebaseappname) | string | The (read-only) name for this app.<!-- -->The default app's name is <code>&quot;[DEFAULT]&quot;</code>. |
29-
| [options](./app.firebaseapp.md#firebaseappoptions) | [FirebaseOptions](./app.firebaseoptions.md#firebaseoptions_interface) | The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.md#initializeapp)<!-- -->. |
29+
| [options](./app.firebaseapp.md#firebaseappoptions) | [FirebaseOptions](./app.firebaseoptions.md#firebaseoptions_interface) | The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.md#initializeapp_cb2f5e1)<!-- -->. |
3030

3131
## FirebaseApp.automaticDataCollectionEnabled
3232

@@ -72,7 +72,7 @@ console.log(otherApp.name); // "other"
7272

7373
## FirebaseApp.options
7474

75-
The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.md#initializeapp)<!-- -->.
75+
The (read-only) configuration options for this app. These are the original parameters given in [initializeApp()](./app.md#initializeapp_cb2f5e1)<!-- -->.
7676

7777
<b>Signature:</b>
7878

docs-devsite/app.firebaseappsettings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
1010
{% endcomment %}
1111

1212
# FirebaseAppSettings interface
13-
Configuration options given to [initializeApp()](./app.md#initializeapp)
13+
Configuration options given to [initializeApp()](./app.md#initializeapp_cb2f5e1)
1414

1515
<b>Signature:</b>
1616

0 commit comments

Comments
 (0)