Skip to content

Commit

Permalink
format changes, spelling mistake
Browse files Browse the repository at this point in the history
  • Loading branch information
DellaBitta committed Jan 29, 2024
1 parent 06d7998 commit 22d18f8
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions docs-devsite/app.firebaseserverappsettings.md
Expand Up @@ -23,7 +23,7 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings
| Property | Type | Description |
| --- | --- | --- |
| [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. |
| [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. |
| [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. |
| [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. |
Expand All @@ -35,7 +35,7 @@ If provided, the FirebaseServerApp instance will work to validate the token even
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 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.
Expand Down
2 changes: 1 addition & 1 deletion packages/app/src/api.ts
Expand Up @@ -184,7 +184,7 @@ export function initializeApp(
* Creates and initializes a {@link @firebase/app#FirebaseServerApp} instance.
*
* The FirebaseServerApp is similar to FirebaseApp, but is intended for execution in
* server side rendering environments only. Initialization will fail if invoked from a
* server side rendering environments only. Initialization will fail if invoked from a
* browser environment.
*
* See
Expand Down
6 changes: 3 additions & 3 deletions packages/app/src/public-types.ts
Expand Up @@ -88,7 +88,7 @@ export interface FirebaseServerApp extends FirebaseApp {
*
* It is recommend that your application awaits this promise before invoking getAuth() if an
* authIdToken was provided in the FirebaseServerAppSettings.
*
*
* The returned Promise is completed immediately if the optional authIdToken parameter
* was omitted from FirebaseServerApp initialization.
*/
Expand Down Expand Up @@ -203,10 +203,10 @@ export interface FirebaseServerAppSettings extends FirebaseAppSettings {
* 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
* 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.
Expand Down

0 comments on commit 22d18f8

Please sign in to comment.