Skip to content
35 changes: 29 additions & 6 deletions packages/firebase/externs/firebase-auth-externs.js
Original file line number Diff line number Diff line change
Expand Up @@ -1045,6 +1045,9 @@ firebase.auth.Auth.prototype.useDeviceLanguage = function() {};
* Creates a new user account associated with the specified email address and
* password and returns any additional user info data or credentials.
*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add another paragraph.

This method will be renamed to createUserWithEmailAndPassword replacing the existing method with the same name in the next major version change.

Do the same for the other 3.

* This method will be renamed to createUserWithEmailAndPassword replacing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

encapsulate createUserWithEmailAndPassword with ticks ` here and below.

* the existing method with the same name in the next major version change.
*
* On successful creation of the user account, this user will also be
* signed in to your application.
*
Expand Down Expand Up @@ -1094,7 +1097,10 @@ firebase.auth.Auth.prototype.createUserAndRetrieveDataWithEmailAndPassword = fun

/**
* Creates a new user account associated with the specified email address and
* password. Will be depercated, replaced by
* password.
*
* This method will be deprecated and will be updated to resolve with a
* firebase.auth.UserCredential as is returned in
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

encapsulate firebase.auth.UserCredential with ticks `

* {@link firebase.auth.Auth#createUserAndRetrieveDataWithEmailAndPassword}.
*
* On successful creation of the user account, this user will also be
Expand Down Expand Up @@ -1437,6 +1443,9 @@ firebase.auth.Auth.prototype.signInAndRetrieveDataWithCredential = function(
* Signs in a user asynchronously using a custom token and returns any
* additional user info data or credentials.
*
* This method will be renamed to signInWithCustomToken replacing
* the existing method with the same name in the next major version change.
*
* Custom tokens are used to integrate Firebase Auth with existing auth systems,
* and must be generated by the auth backend.
*
Expand Down Expand Up @@ -1472,7 +1481,10 @@ firebase.auth.Auth.prototype.signInAndRetrieveDataWithCustomToken = function(
) {};

/**
* Asynchronously signs in using a custom token. Will be depercated, replaced by
* Asynchronously signs in using a custom token.
*
* This method will be deprecated and will be updated to resolve with a
* firebase.auth.UserCredential as is returned in
* {@link firebase.auth.Auth#signInAndRetrieveDataWithCustomToken}.
*
* Custom tokens are used to integrate Firebase Auth with existing auth systems,
Expand Down Expand Up @@ -1510,6 +1522,9 @@ firebase.auth.Auth.prototype.signInWithCustomToken = function(token) {};
* Asynchronously signs in using an email and password and returns any additional
* user info data or credentials.
*
* This method will be renamed to signInWithEmailAndPassword replacing
* the existing method with the same name in the next major version change.
*
* Fails with an error if the email address and password do not match.
*
* Note: The user's password is NOT the password used to access the user's email
Expand Down Expand Up @@ -1557,8 +1572,10 @@ firebase.auth.Auth.prototype.signInAndRetrieveDataWithEmailAndPassword = functio
) {};

/**
* Asynchronously signs in using an email and password. Will be depercated,
* replaced by
* Asynchronously signs in using an email and password.
*
* This method will be deprecated and will be updated to resolve with a
* firebase.auth.UserCredential as is returned in
* {@link firebase.auth.Auth#signInAndRetrieveDataWithEmailAndPassword}.
*
* Fails with an error if the email address and password do not match.
Expand Down Expand Up @@ -1697,6 +1714,9 @@ firebase.auth.ConfirmationResult.prototype.confirm = function(
* Signs in a user anonymously and returns any additional user info data or
* credentials.
*
* This method will be renamed to signInAnonymously replacing the existing
* method with the same name in the next major version change.
*
* If there is already an anonymous user signed in, that user with
* additional date will be returned; otherwise, a new anonymous user
* identity will be created and returned.
Expand Down Expand Up @@ -1726,8 +1746,11 @@ firebase.auth.ConfirmationResult.prototype.confirm = function(
firebase.auth.Auth.prototype.signInAnonymouslyAndRetrieveData = function() {};

/**
* Asynchronously signs in as an anonymous user. Will be depercated, replaced
* by {@link firebase.auth.Auth#signInAnonymouslyAndRetrieveData}.
* Asynchronously signs in as an anonymous user.
*
* This method will be deprecated and will be updated to resolve with a
* firebase.auth.UserCredential as is returned in
* {@link firebase.auth.Auth#signInAnonymouslyAndRetrieveData}.
*
* If there is already an anonymous user signed in, that user will be returned;
* otherwise, a new anonymous user identity will be created and returned.
Expand Down