PR Feedback

Author: avolkovi

docs-exp/auth-types.auth.languagecode.md

@@ -4,7 +4,7 @@
 
 ## Auth.languageCode property
 
-The current Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified.
+The Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified.
 
 <b>Signature:</b>
 

docs-exp/auth-types.auth.md

@@ -20,20 +20,20 @@ export interface Auth
 |  --- | --- | --- |
 |  [config](./auth-types.auth.config.md) | [Config](./auth-types.config.md) | The [Config](./auth-types.config.md) used to initialize this instance. |
 |  [currentUser](./auth-types.auth.currentuser.md) | [User](./auth-types.user.md) \| null | The currently signed-in user (or null). |
-|  [languageCode](./auth-types.auth.languagecode.md) | string \| null | The current Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified. |
+|  [languageCode](./auth-types.auth.languagecode.md) | string \| null | The Auth instance's language code. This is a readable/writable property. When set to null, the default Firebase Console language setting is applied. The language code will propagate to email action templates (password reset, email verification and email change revocation), SMS templates for phone authentication, reCAPTCHA verifier and OAuth popup/redirect operations provided the specified providers support localization with the language code specified. |
 |  [name](./auth-types.auth.name.md) | string | The name of the app associated with the Auth service instance. |
-|  [settings](./auth-types.auth.settings.md) | [AuthSettings](./auth-types.authsettings.md) | The current Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication. |
-|  [tenantId](./auth-types.auth.tenantid.md) | string \| null | The current Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null. |
+|  [settings](./auth-types.auth.settings.md) | [AuthSettings](./auth-types.authsettings.md) | The Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication. |
+|  [tenantId](./auth-types.auth.tenantid.md) | string \| null | The Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null. |
 
 ## Methods
 
 |  Method | Description |
 |  --- | --- |
-|  [onAuthStateChanged(nextOrObserver, error, completed)](./auth-types.auth.onauthstatechanged.md) | Adds an observer for changes to the user's sign-in state.<!-- -->Prior to 4.0.0, this triggered the observer when users were signed in, signed out, or when the user's ID token changed in situations such as token expiry or password change. After 4.0.0, the observer is only triggered on sign-in or sign-out.<!-- -->To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md)<!-- -->. |
-|  [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. This method has the same behavior as [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) had prior to 4.0.0. |
-|  [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | Changes the current type of persistence on the current Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.<!-- -->This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. |
+|  [onAuthStateChanged(nextOrObserver, error, completed)](./auth-types.auth.onauthstatechanged.md) | Adds an observer for changes to the user's sign-in state.<!-- -->To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md)<!-- -->. |
+|  [onIdTokenChanged(nextOrObserver, error, completed)](./auth-types.auth.onidtokenchanged.md) | Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. |
+|  [setPersistence(persistence)](./auth-types.auth.setpersistence.md) | Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.<!-- -->This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data. |
 |  [signOut()](./auth-types.auth.signout.md) | Signs out the current user. |
-|  [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as <code>currentUser</code> on the current Auth instance. A new instance copy of the user provided will be made and set as currentUser.<!-- -->This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.<!-- -->The operation fails with an error if the user to be updated belongs to a different Firebase project. |
+|  [updateCurrentUser(user)](./auth-types.auth.updatecurrentuser.md) | Asynchronously sets the provided user as <code>currentUser</code> on the Auth instance. A new instance copy of the user provided will be made and set as currentUser.<!-- -->This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.<!-- -->The operation fails with an error if the user to be updated belongs to a different Firebase project. |
 |  [useDeviceLanguage()](./auth-types.auth.usedevicelanguage.md) | Sets the current language to the default device/browser preference. |
 |  [useEmulator(url)](./auth-types.auth.useemulator.md) | Modify this Auth instance to communicate with the Firebase Auth emulator. This must be called synchronously immediately following the first call to <code>firebase.auth()</code>. Do not use with production credentials as emulator traffic is not encrypted. |
 

docs-exp/auth-types.auth.onauthstatechanged.md

@@ -6,8 +6,6 @@
 
 Adds an observer for changes to the user's sign-in state.
 
-Prior to 4.0.0, this triggered the observer when users were signed in, signed out, or when the user's ID token changed in situations such as token expiry or password change. After 4.0.0, the observer is only triggered on sign-in or sign-out.
-
 To keep the old behavior, see [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md)<!-- -->.
 
 <b>Signature:</b>

docs-exp/auth-types.auth.onidtokenchanged.md

@@ -4,7 +4,7 @@
 
 ## Auth.onIdTokenChanged() method
 
-Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events. This method has the same behavior as [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) had prior to 4.0.0.
+Adds an observer for changes to the signed-in user's ID token, which includes sign-in, sign-out, and token refresh events.
 
 <b>Signature:</b>
 

docs-exp/auth-types.auth.setpersistence.md

@@ -4,7 +4,7 @@
 
 ## Auth.setPersistence() method
 
-Changes the current type of persistence on the current Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.
+Changes the type of persistence on the Auth instance for the currently saved Auth session and applies this type of persistence for future sign-in requests, including sign-in with redirect requests.
 
 This makes it easy for a user signing in to specify whether their session should be remembered or not. It also makes it easier to never persist the Auth state for applications that are shared by other users or have sensitive data.
 

docs-exp/auth-types.auth.settings.md

@@ -4,7 +4,7 @@
 
 ## Auth.settings property
 
-The current Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication.
+The Auth instance's settings. This is used to edit/read configuration related options like app verification mode for phone authentication.
 
 <b>Signature:</b>
 

docs-exp/auth-types.auth.tenantid.md

@@ -4,7 +4,7 @@
 
 ## Auth.tenantId property
 
-The current Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null.
+The Auth instance's tenant ID. This is a readable/writable property. When you set the tenant ID of an Auth instance, all future sign-in/sign-up operations will pass this tenant ID and sign in or sign up users to the specified tenant project. When set to null, users are signed in to the parent project. By default, this is set to null.
 
 <b>Signature:</b>
 
@@ -17,11 +17,11 @@ tenantId: string | null;
 
 ```
 // Set the tenant ID on Auth instance.
-auth.tenantId = ‘TENANT_PROJECT_ID’;
+auth.tenantId = 'TENANT_PROJECT_ID';
 
 // All future sign-in request now include tenant ID.
 const result = await signInWithEmailAndPassword(auth, email, password);
-// result.user.tenantId should be ‘TENANT_PROJECT_ID’.
+// result.user.tenantId should be 'TENANT_PROJECT_ID'.
 
 ```
 

docs-exp/auth-types.auth.updatecurrentuser.md

@@ -4,7 +4,7 @@
 
 ## Auth.updateCurrentUser() method
 
-Asynchronously sets the provided user as `currentUser` on the current Auth instance. A new instance copy of the user provided will be made and set as currentUser.
+Asynchronously sets the provided user as `currentUser` on the Auth instance. A new instance copy of the user provided will be made and set as currentUser.
 
 This will trigger [Auth.onAuthStateChanged()](./auth-types.auth.onauthstatechanged.md) and [Auth.onIdTokenChanged()](./auth-types.auth.onidtokenchanged.md) listeners like other sign in methods.
 

docs-exp/auth-types.autherror.email.md

@@ -4,7 +4,7 @@
 
 ## AuthError.email property
 
-The email of the user's account used for sign-in/linking.
+The email of the user's account, used for sign-in/linking.
 
 <b>Signature:</b>
 

docs-exp/auth-types.autherror.md

@@ -17,7 +17,7 @@ export interface AuthError extends FirebaseError
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [appName](./auth-types.autherror.appname.md) | string | The name of the Firebase App which triggered this error. |
-|  [email](./auth-types.autherror.email.md) | string | The email of the user's account used for sign-in/linking. |
-|  [phoneNumber](./auth-types.autherror.phonenumber.md) | string | The phone number of the user's account used for sign-in/linking. |
+|  [email](./auth-types.autherror.email.md) | string | The email of the user's account, used for sign-in/linking. |
+|  [phoneNumber](./auth-types.autherror.phonenumber.md) | string | The phone number of the user's account, used for sign-in/linking. |
 |  [tenantid](./auth-types.autherror.tenantid.md) | string | The tenant ID being used for sign-in/linking. If you use <code>signInWithRedirect</code> to sign in, you have to set the tenant ID on [Auth](./auth-types.auth.md) instance again as the tenant ID is not persisted after redirection. |
 

docs-exp/auth-types.autherror.phonenumber.md

@@ -4,7 +4,7 @@
 
 ## AuthError.phoneNumber property
 
-The phone number of the user's account used for sign-in/linking.
+The phone number of the user's account, used for sign-in/linking.
 
 <b>Signature:</b>
 

docs-exp/auth-types.idtokenresult.issuedattime.md

@@ -4,7 +4,7 @@
 
 ## IdTokenResult.issuedAtTime property
 
-The ID token issued at time formatted as a UTC string.
+The ID token issuance time formatted as a UTC string.
 
 <b>Signature:</b>
 

docs-exp/auth-types.idtokenresult.md

@@ -21,7 +21,7 @@ export interface IdTokenResult
 |  [authTime](./auth-types.idtokenresult.authtime.md) | string | The authentication time formatted as a UTC string. This is the time the user authenticated (signed in) and not the time the token was refreshed. |
 |  [claims](./auth-types.idtokenresult.claims.md) | [ParsedToken](./auth-types.parsedtoken.md) | The entire payload claims of the ID token including the standard reserved claims as well as the custom claims. |
 |  [expirationTime](./auth-types.idtokenresult.expirationtime.md) | string | The ID token expiration time formatted as a UTC string. |
-|  [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) | string | The ID token issued at time formatted as a UTC string. |
+|  [issuedAtTime](./auth-types.idtokenresult.issuedattime.md) | string | The ID token issuance time formatted as a UTC string. |
 |  [signInProvider](./auth-types.idtokenresult.signinprovider.md) | string \| null | The sign-in provider through which the ID token was obtained (anonymous, custom, phone, password, etc). Note, this does not map to provider IDs. |
 |  [signInSecondFactor](./auth-types.idtokenresult.signinsecondfactor.md) | string \| null | The type of second factor associated with this session, provided the user was multi-factor authenticated (eg. phone, etc). |
 |  [token](./auth-types.idtokenresult.token.md) | string | The Firebase Auth ID token JWT string. |

docs-exp/auth-types.md

@@ -56,7 +56,7 @@
 |  [PopupRedirectResolver](./auth-types.popupredirectresolver.md) | A resolver used for handling DOM specific operations like <code>signInWithPopup()</code> or <code>signInWithRedirect()</code> |
 |  [ReactNativeAsyncStorage](./auth-types.reactnativeasyncstorage.md) |  |
 |  [User](./auth-types.user.md) | A user account. |
-|  [UserCredential](./auth-types.usercredential.md) | A structure containing a User, an AuthCredential, the <code>operationType</code>, and any additional user information that was returned from the identity provider. operationType could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. |
+|  [UserCredential](./auth-types.usercredential.md) | A structure containing a User, an AuthCredential, the <code>operationType</code>, and any additional user information that was returned from the identity provider. <code>operationType</code> could be [OperationType.SIGN\_IN](./auth-types.operationtype.sign_in.md) for a sign-in operation, [OperationType.LINK](./auth-types.operationtype.link.md) for a linking operation and [OperationType.REAUTHENTICATE](./auth-types.operationtype.reauthenticate.md) for a reauthentication operation. |
 |  [UserInfo](./auth-types.userinfo.md) | User profile information, visible only to the Firebase project's apps. |
 |  [UserMetadata](./auth-types.usermetadata.md) | Interface representing a user's metadata. |
 

docs-exp/auth-types.multifactorerror.md

@@ -33,10 +33,8 @@ signInWithEmailAndPassword(auth, email, password)
       }
     });
 
-resolver.resolveSignIn(multiFactorAssertion)
-    .then(function(userCredential) {
-      // User signed in.
-    });
+const userCredential = await resolver.resolveSignIn(multiFactorAssertion);
+// User signed in.
 
 ```
 

docs-exp/auth-types.multifactorresolver.md

@@ -40,29 +40,21 @@ signInWithEmailAndPassword(auth, email, password)
 // UI needs to be presented to allow the user to select a second factor
 // from that list.
 
-var selectedHint = // ; selected from multiFactorHints
-var phoneAuthProvider = new PhoneAuthProvider();
-var phoneInfoOptions = {
+const selectedHint = // ; selected from multiFactorHints
+const phoneAuthProvider = new PhoneAuthProvider();
+const phoneInfoOptions = {
   multiFactorHint: selectedHint,
   session: resolver.session
 };
-phoneAuthProvider.verifyPhoneNumber(
-  phoneInfoOptions,
-  appVerifier
-).then((verificationId) => {
-  // store verificationID and show UI to let user enter verification code.
-});
+const verificationId = phoneAuthProvider.verifyPhoneNumber(phoneInfoOptions, appVerifier);
+// store verificationID and show UI to let user enter verification code.
 
 // UI to enter verification code and continue.
 // Continue button click handler
-var phoneAuthCredential =
-    PhoneAuthProvider.credential(verificationId, verificationCode);
-var multiFactorAssertion =
-    PhoneMultiFactorGenerator.assertion(phoneAuthCredential);
-resolver.resolveSignIn(multiFactorAssertion)
-    .then((userCredential) => {
-      // User signed in.
-    });
+const phoneAuthCredential = PhoneAuthProvider.credential(verificationId, verificationCode);
+const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(phoneAuthCredential);
+const userCredential = await resolver.resolveSignIn(multiFactorAssertion);
+// User signed in.
 
 ```
 

docs-exp/auth-types.multifactoruser.enroll.md

@@ -4,7 +4,7 @@
 
 ## MultiFactorUser.enroll() method
 
-Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the current user. On resolution, the user tokens are updated to reflect the change in the JWT payload. Accepts an additional display name parameter used to identify the second factor to the end user. Recent re-authentication is required for this operation to succeed. On successful enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is enrolled, an email notification is sent to the user’s email.
+Enrolls a second factor as identified by the [MultiFactorAssertion](./auth-types.multifactorassertion.md) for the user. On resolution, the user tokens are updated to reflect the change in the JWT payload. Accepts an additional display name parameter used to identify the second factor to the end user. Recent re-authentication is required for this operation to succeed. On successful enrollment, existing Firebase sessions (refresh tokens) are revoked. When a new factor is enrolled, an email notification is sent to the user’s email.
 
 <b>Signature:</b>
 
@@ -30,7 +30,7 @@ Promise&lt;void&gt;
 
 
 ```
-const multiFactorUser = multiFactor(firebase.auth().currentUser);
+const multiFactorUser = multiFactor(auth.currentUser);
 const multiFactorSession = await multiFactorUser.getSession();
 // Send verification code
 const phoneAuthProvider = new PhoneAuthProvider();

docs-exp/auth-types.multifactoruser.getsession.md

@@ -4,7 +4,7 @@
 
 ## MultiFactorUser.getSession() method
 
-Returns the session identifier for a second factor enrollment operation. This is used to identify the current user trying to enroll a second factor.
+Returns the session identifier for a second factor enrollment operation. This is used to identify the user trying to enroll a second factor.
 
 <b>Signature:</b>