Skip to content

Fix documentation links for function overloads and improve readability of function headings #7864

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
216 changes: 114 additions & 102 deletions docs-devsite/analytics.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs-devsite/app-check.customprovider.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Constructs a new instance of the `CustomProvider` class
constructor(_customProviderOptions: CustomProviderOptions);
```
### Parameters
#### Parameters
| Parameter | Type | Description |
| --- | --- | --- |
Expand Down
44 changes: 24 additions & 20 deletions docs-devsite/app-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Prov

| Function | Description |
| --- | --- |
| <b>function(app...)</b> |
| [initializeAppCheck(app, options)](./app-check.md#initializeappcheck) | Activate App Check for the given app. Can be called only once per app. |
| <b>function(appCheckInstance...)</b> |
| [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. |
| [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. |
| [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. |
| [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. |
| [setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)](./app-check.md#settokenautorefreshenabled) | Set whether App Check will automatically refresh tokens as needed. |
| <b>function(app, ...)</b> |
| [initializeAppCheck(app, options)](./app-check.md#initializeappcheck_5548dfc) | Activate App Check for the given app. Can be called only once per app. |
| <b>function(appCheckInstance, ...)</b> |
| [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. |
| [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. |
| [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. |
| [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. |
| [setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled)](./app-check.md#settokenautorefreshenabled_057a76c) | Set whether App Check will automatically refresh tokens as needed. |

## Classes

Expand All @@ -51,7 +51,9 @@ Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Prov
| --- | --- |
| [AppCheckTokenListener](./app-check.md#appchecktokenlistener) | A listener that is called whenever the App Check token changes. |

## initializeAppCheck()
## function(app, ...)

### initializeAppCheck(app, options) {:#initializeappcheck_5548dfc}

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

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

### Parameters
#### Parameters

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

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

## getLimitedUseToken()
## function(appCheckInstance, ...)

### getLimitedUseToken(appCheckInstance) {:#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.

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

### Parameters
#### Parameters

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

The limited use token.

## getToken()
### getToken(appCheckInstance, forceRefresh) {:#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.

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

### Parameters
#### Parameters

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

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

## onTokenChanged()
### onTokenChanged(appCheckInstance, observer) {:#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.

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

### Parameters
#### Parameters

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

A function that unsubscribes this listener.

## onTokenChanged()
### onTokenChanged(appCheckInstance, onNext, onError, onCompletion) {:#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.

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

### Parameters
#### Parameters

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

A function that unsubscribes this listener.

## setTokenAutoRefreshEnabled()
### setTokenAutoRefreshEnabled(appCheckInstance, isTokenAutoRefreshEnabled) {:#settokenautorefreshenabled_057a76c}

Set whether App Check will automatically refresh tokens as needed.

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

### Parameters
#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/app-check.recaptchaenterpriseprovider.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Create a ReCaptchaEnterpriseProvider instance.
constructor(_siteKey: string);
```
### Parameters
#### Parameters
| Parameter | Type | Description |
| --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/app-check.recaptchav3provider.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Create a ReCaptchaV3Provider instance.
constructor(_siteKey: string);
```
### Parameters
#### Parameters
| Parameter | Type | Description |
| --- | --- | --- |
Expand Down
6 changes: 3 additions & 3 deletions docs-devsite/app.firebaseapp.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ https://github.com/firebase/firebase-js-sdk
# FirebaseApp interface
A [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) holds the initialization information for a collection of services.

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

<b>Signature:</b>

Expand All @@ -26,7 +26,7 @@ export interface FirebaseApp
| --- | --- | --- |
| [automaticDataCollectionEnabled](./app.firebaseapp.md#firebaseappautomaticdatacollectionenabled) | boolean | The settable config flag for GDPR opt-in/opt-out |
| [name](./app.firebaseapp.md#firebaseappname) | string | The (read-only) name for this app.<!-- -->The default app's name is <code>&quot;[DEFAULT]&quot;</code>. |
| [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)<!-- -->. |
| [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)<!-- -->. |

## FirebaseApp.automaticDataCollectionEnabled

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

## FirebaseApp.options

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

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/app.firebaseappsettings.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# FirebaseAppSettings interface
Configuration options given to [initializeApp()](./app.md#initializeapp)
Configuration options given to [initializeApp()](./app.md#initializeapp_cb2f5e1)

<b>Signature:</b>

Expand Down
Loading