Skip to content

docs: Improve readability of headings for functions. #7869

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.

Sign up for GitHub

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 1 commit into from
Dec 15, 2023
Merged

docs: Improve readability of headings for functions. #7869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
152 changes: 82 additions & 70 deletions docs-devsite/analytics.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs-devsite/app-check.customprovider.md
View file
Open in desktop
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
32 changes: 18 additions & 14 deletions docs-devsite/app-check.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ Firebase App Check does not work in a Node.js environment using `ReCaptchaV3Prov

| Function | Description |
| --- | --- |
| <b>function(app...)</b> |
| <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> |
| <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. |
Expand Down Expand Up @@ -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() {:#initializeappcheck_5548dfc}
## 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() {:#getlimitedusetoken_53ef5e3}
## 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_39fc1b3}
### 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_9761e16}
### 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_8ef80a7}
### 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_057a76c}
### 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
View file
Open in desktop
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
View file
Open in desktop
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
58 changes: 36 additions & 22 deletions docs-devsite/app.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,20 +18,20 @@ This package coordinates the communication between the different Firebase compon

| Function | Description |
| --- | --- |
| <b>function(app...)</b> |
| <b>function(app, ...)</b> |
| [deleteApp(app)](./app.md#deleteapp_cf608e1) | Renders this app unusable and frees the resources of all associated services. |
| <b>function()</b> |
| [getApps()](./app.md#getapps) | A (read-only) array of all initialized apps. |
| [initializeApp()](./app.md#initializeapp) | Creates and initializes a FirebaseApp instance. |
| <b>function(libraryKeyOrName...)</b> |
| <b>function(libraryKeyOrName, ...)</b> |
| [registerVersion(libraryKeyOrName, version, variant)](./app.md#registerversion_f673248) | Registers a library's name and version for platform logging purposes. |
| <b>function(logCallback...)</b> |
| <b>function(logCallback, ...)</b> |
| [onLog(logCallback, options)](./app.md#onlog_fd46eae) | Sets log handler for all Firebase SDKs. |
| <b>function(logLevel...)</b> |
| <b>function(logLevel, ...)</b> |
| [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). |
| <b>function(name...)</b> |
| <b>function(name, ...)</b> |
| [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. |
| <b>function(options...)</b> |
| <b>function(options, ...)</b> |
| [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. |
| [initializeApp(options, config)](./app.md#initializeapp_079e917) | Creates and initializes a FirebaseApp instance. |

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

## deleteApp() {:#deleteapp_cf608e1}
## function(app, ...)

### deleteApp(app) {:#deleteapp_cf608e1}

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

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

### Parameters
#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
Expand All @@ -83,7 +85,9 @@ deleteApp(app)

```

## getApps() {:#getapps}
## function()

### getApps() {:#getapps}

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

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

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

## initializeApp() {:#initializeapp}
### initializeApp() {:#initializeapp}

Creates and initializes a FirebaseApp instance.

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

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

## registerVersion() {:#registerversion_f673248}
## function(libraryKeyOrName, ...)

### registerVersion(libraryKeyOrName, version, variant) {:#registerversion_f673248}

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

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

### Parameters
#### Parameters

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

void

## onLog() {:#onlog_fd46eae}
## function(logCallback, ...)

### onLog(logCallback, options) {:#onlog_fd46eae}

Sets log handler for all Firebase SDKs.

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

### Parameters
#### Parameters

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

void

## setLogLevel() {:#setloglevel_697d53a}
## function(logLevel, ...)

### setLogLevel(logLevel) {:#setloglevel_697d53a}

Sets log level for all Firebase SDKs.

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

### Parameters
#### Parameters

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

void

## getApp() {:#getapp_1eaaff4}
## function(name, ...)

### getApp(name) {:#getapp_1eaaff4}

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

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

### Parameters
#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
Expand Down Expand Up @@ -218,7 +230,9 @@ const otherApp = getApp("otherApp");

```

## initializeApp() {:#initializeapp_cb2f5e1}
## function(options, ...)

### initializeApp(options, name) {:#initializeapp_cb2f5e1}

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

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

### Parameters
#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
Expand Down Expand Up @@ -274,7 +288,7 @@ const otherApp = initializeApp({

```

## initializeApp() {:#initializeapp_079e917}
### initializeApp(options, config) {:#initializeapp_079e917}

Creates and initializes a FirebaseApp instance.

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

### Parameters
#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/auth.actioncodeurl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Parses the email action link string and returns an [ActionCodeURL](./auth.action
static parseLink(link: string): ActionCodeURL | null;
```

### Parameters
#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
Expand Down
10 changes: 5 additions & 5 deletions docs-devsite/auth.auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ Adds a blocking callback that runs before an auth state change sets a new user.
beforeAuthStateChanged(callback: (user: User | null) => void | Promise<void>, onAbort?: () => void): Unsubscribe;
```

### Parameters
#### Parameters

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

### Parameters
#### Parameters

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

### Parameters
#### Parameters

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

### Parameters
#### Parameters

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

### Parameters
#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/auth.confirmationresult.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Finishes a phone number sign-in, link, or reauthentication.
confirm(verificationCode: string): Promise<UserCredential>;
```

### Parameters
#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
Expand Down
Loading