File tree 2 files changed +6
-4
lines changed
2 files changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -2008,15 +2008,16 @@ export namespace FirebaseAuthTypes {
2008
2008
sendSignInLinkToEmail ( email : string , actionCodeSettings ?: ActionCodeSettings ) : Promise < void > ;
2009
2009
2010
2010
/**
2011
- * Returns whether the user signed in with a given email link.
2011
+ * Checks if an incoming link is a sign-in with email link suitable for signInWithEmailLink.
2012
+ * Note that android and other platforms require `apiKey` link parameter for signInWithEmailLink
2012
2013
*
2013
2014
* #### Example
2014
2015
*
2015
2016
* ```js
2016
- * const signedInWithLink = await firebase.auth().isSignInWithEmailLink(link);
2017
+ * const valid = await firebase.auth().isSignInWithEmailLink(link);
2017
2018
* ```
2018
2019
*
2019
- * @param emailLink The email link to check whether the user signed in with it.
2020
+ * @param emailLink The email link to verify prior to using signInWithEmailLink
2020
2021
*/
2021
2022
isSignInWithEmailLink ( emailLink : string ) : Promise < boolean > ;
2022
2023
Original file line number Diff line number Diff line change @@ -165,7 +165,8 @@ export interface PopupRedirectResolver {}
165
165
export function initializeRecaptchaConfig ( auth : Auth ) : Promise < void > ;
166
166
167
167
/**
168
- * Checks if an incoming link is a sign-in with email link suitable for signInWithEmailLink().
168
+ * Checks if an incoming link is a sign-in with email link suitable for signInWithEmailLink.
169
+ * Note that android and other platforms require `apiKey` link parameter for signInWithEmailLink
169
170
*
170
171
* @param auth - The Auth instance.
171
172
* @param emailLink - The email link to check.
You can’t perform that action at this time.
0 commit comments