Skip to content

Commit 22d18f8

Browse files
committed
format changes, spelling mistake
1 parent 06d7998 commit 22d18f8

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

docs-devsite/app.firebaseserverappsettings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings
2323
2424
| Property | Type | Description |
2525
| --- | --- | --- |
26-
| [authIdToken](./app.firebaseserverappsettings.md#firebaseserverappsettingsauthidtoken) | string | An optional Auth ID token used to resume a signed in user session from a client runtime environment.<!-- -->If provided, the FirebaseServerApp instance will work to validate the token even before Auth is initialized. The result of the validation can be queried via by the application by invoking . Awaiting the Promise returned by is highly recommended if an authIdToken token is provided.<!-- -->Invoking getAuth() with a FirebaseServerApp configured with a validated authIdToken will cause an automatic attempt to sign in the user that the authIdToken represents. The token needs to have been recently minted for this operation to succeed, otherwise it will fail validation.<!-- -->If the token fails local verfiication, or if the Auth service has deemed it invalid when the Auth SDK is initialized, then a warning is logged to the console and the Auth SDK will not sign in a user upon initalization.<!-- -->If a user is successfully signed-in, then the Auth instance's onAuthStateChanged callback will be invoked with the User as per standard Auth flows. However, users created via authIdTokens do not have a refresh token and any attempted refresh operation will fail. |
26+
| [authIdToken](./app.firebaseserverappsettings.md#firebaseserverappsettingsauthidtoken) | string | An optional Auth ID token used to resume a signed in user session from a client runtime environment.<!-- -->If provided, the FirebaseServerApp instance will work to validate the token even before Auth is initialized. The result of the validation can be queried via by the application by invoking . Awaiting the Promise returned by is highly recommended if an authIdToken token is provided.<!-- -->Invoking getAuth() with a FirebaseServerApp configured with a validated authIdToken will cause an automatic attempt to sign in the user that the authIdToken represents. The token needs to have been recently minted for this operation to succeed, otherwise it will fail validation.<!-- -->If the token fails local verification, or if the Auth service has deemed it invalid when the Auth SDK is initialized, then a warning is logged to the console and the Auth SDK will not sign in a user upon initalization.<!-- -->If a user is successfully signed-in, then the Auth instance's onAuthStateChanged callback will be invoked with the User as per standard Auth flows. However, users created via authIdTokens do not have a refresh token and any attempted refresh operation will fail. |
2727
| [name](./app.firebaseserverappsettings.md#firebaseserverappsettingsname) | undefined | There is no get for FirebaseServerApps, so the name is not relevant. however it's always a blank string so that FirebaseServerApp conforms to the FirebaseApp interface declaration. |
2828
| [releaseOnDeref](./app.firebaseserverappsettings.md#firebaseserverappsettingsreleaseonderef) | object | An optional object. If provided, the Firebase SDK will use a FinalizationRegistry object to monitor the Garbage Collection status of the provided object, and the Firebase SDK will release its refrence on the FirebaseServerApp instance when the provided object is garbage collected.<!-- -->The intent of this field is to help reduce memory overhead for long-running cloud functions. If provided, the customer's app running in a SSR pass need not worry about FirebaseServerApp 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 FirebaseServerApp instance by invoking deleteApp.<!-- -->If the application provides an object in this parameter, but the application is executed in a JavaScript engine that predates the support of FinalizationRegistry (introduced in node v14.6.0, for instance), then the Firebase SDK will not be able to automatically clean up the FirebaseServerApp instance and an error will be thrown. |
2929
@@ -35,7 +35,7 @@ If provided, the FirebaseServerApp instance will work to validate the token even
3535
3636
Invoking getAuth() with a FirebaseServerApp configured with a validated authIdToken will cause an automatic attempt to sign in the user that the authIdToken represents. The token needs to have been recently minted for this operation to succeed, otherwise it will fail validation.
3737
38-
If the token fails local verfiication, or if the Auth service has deemed it invalid when the Auth SDK is initialized, then a warning is logged to the console and the Auth SDK will not sign in a user upon initalization.
38+
If the token fails local verification, or if the Auth service has deemed it invalid when the Auth SDK is initialized, then a warning is logged to the console and the Auth SDK will not sign in a user upon initalization.
3939
4040
If a user is successfully signed-in, then the Auth instance's onAuthStateChanged callback will be invoked with the User as per standard Auth flows. However, users created via authIdTokens do not have a refresh token and any attempted refresh operation will fail.
4141

packages/app/src/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ export function initializeApp(
184184
* Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
185185
*
186186
* The FirebaseServerApp is similar to FirebaseApp, but is intended for execution in
187-
* server side rendering environments only. Initialization will fail if invoked from a
187+
* server side rendering environments only. Initialization will fail if invoked from a
188188
* browser environment.
189189
*
190190
* See

packages/app/src/public-types.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ export interface FirebaseServerApp extends FirebaseApp {
8888
*
8989
* It is recommend that your application awaits this promise before invoking getAuth() if an
9090
* authIdToken was provided in the FirebaseServerAppSettings.
91-
*
91+
*
9292
* The returned Promise is completed immediately if the optional authIdToken parameter
9393
* was omitted from FirebaseServerApp initialization.
9494
*/
@@ -203,10 +203,10 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings {
203203
* needs to have been recently minted for this operation to succeed, otherwise it will fail
204204
* validation.
205205
*
206-
* If the token fails local verfiication, or if the Auth service has deemed it invalid when
206+
* If the token fails local verification, or if the Auth service has deemed it invalid when
207207
* the Auth SDK is initialized, then a warning is logged to the console and the Auth SDK will not
208208
* sign in a user upon initalization.
209-
*
209+
*
210210
* If a user is successfully signed-in, then the Auth instance's onAuthStateChanged callback
211211
* will be invoked with the User as per standard Auth flows. However, users created via
212212
* authIdTokens do not have a refresh token and any attempted refresh operation will fail.

0 commit comments

Comments
 (0)