Skip to content

Commit 5ff07dd

Browse files
committed
Generate refdocs
1 parent b71a10f commit 5ff07dd

File tree

1 file changed

+2
-13
lines changed

1 file changed

+2
-13
lines changed

docs-devsite/app.firebaseserverappsettings.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,16 +15,15 @@ Configuration options given to [initializeServerApp()](./app.md#initializeserver
1515
<b>Signature:</b>
1616

1717
```typescript
18-
export interface FirebaseServerAppSettings extends FirebaseAppSettings
18+
export interface FirebaseServerAppSettings extends Omit<FirebaseAppSettings, "name?">
1919
```
20-
<b>Extends:</b> [FirebaseAppSettings](./app.firebaseappsettings.md#firebaseappsettings_interface)
20+
<b>Extends:</b> Omit&lt;[FirebaseAppSettings](./app.firebaseappsettings.md#firebaseappsettings_interface)<!-- -->, "name?"&gt;
2121
2222
## Properties
2323
2424
| Property | Type | Description |
2525
| --- | --- | --- |
2626
| [authIdToken](./app.firebaseserverappsettings.md#firebaseserverappsettingsauthidtoken) | string | An optional Auth ID token used to resume a signed in user session from a client runtime environment.<!-- -->Invoking <code>getAuth</code> with a <code>FirebaseServerApp</code> configured with a validated <code>authIdToken</code> causes an automatic attempt to sign in the user that the <code>authIdToken</code> represents. The token needs to have been recently minted for this operation to succeed.<!-- -->If the token fails local verification, or if the Auth service has failed to validate it when the Auth SDK is initialized, then a warning is logged to the console and the Auth SDK will not sign in a user on initialization.<!-- -->If a user is successfully signed in, then the Auth instance's <code>onAuthStateChanged</code> callback is invoked with the <code>User</code> object as per standard Auth flows. However, <code>User</code> objects created via an <code>authIdToken</code> do not have a refresh token. Attempted <code>refreshToken</code> operations fail. |
27-
| [name](./app.firebaseserverappsettings.md#firebaseserverappsettingsname) | string | There is no <code>getApp()</code> operation for <code>FirebaseServerApp</code>, so the name is not relevant for applications. Therefore, this field will be ignored during <code>FirebaseServerApp</code> initialization, and is defined here solely to conform to TypeScript's <code>exactOptionalPropertyTypes</code> requirements. |
2827
| [releaseOnDeref](./app.firebaseserverappsettings.md#firebaseserverappsettingsreleaseonderef) | object | An optional object. If provided, the Firebase SDK uses a <code>FinalizationRegistry</code> object to monitor the garbage collection status of the provided object. The Firebase SDK releases its reference on the <code>FirebaseServerApp</code> instance when the provided <code>releaseOnDeref</code> object is garbage collected.<!-- -->You can use this field to reduce memory management overhead for your application. If provided, an app running in a SSR pass does not need to perform <code>FirebaseServerApp</code> cleanup, so long as the reference object is deleted (by falling out of SSR scope, for instance.)<!-- -->If an object is not provided then the application must clean up the <code>FirebaseServerApp</code> instance by invoking <code>deleteApp</code>.<!-- -->If the application provides an object in this parameter, but the application is executed in a JavaScript engine that predates the support of <code>FinalizationRegistry</code> (introduced in node v14.6.0, for instance), then an error is thrown at <code>FirebaseServerApp</code> initialization. |
2928
3029
## FirebaseServerAppSettings.authIdToken
@@ -43,16 +42,6 @@ If a user is successfully signed in, then the Auth instance's `onAuthStateChange
4342
authIdToken?: string;
4443
```
4544
46-
## FirebaseServerAppSettings.name
47-
48-
There is no `getApp()` operation for `FirebaseServerApp`<!-- -->, so the name is not relevant for applications. Therefore, this field will be ignored during `FirebaseServerApp` initialization, and is defined here solely to conform to TypeScript's `exactOptionalPropertyTypes` requirements.
49-
50-
<b>Signature:</b>
51-
52-
```typescript
53-
name?: string;
54-
```
55-
5645
## FirebaseServerAppSettings.releaseOnDeref
5746
5847
An optional object. If provided, the Firebase SDK uses a `FinalizationRegistry` object to monitor the garbage collection status of the provided object. The Firebase SDK releases its reference on the `FirebaseServerApp` instance when the provided `releaseOnDeref` object is garbage collected.

0 commit comments

Comments
 (0)