Skip to content

Commit 14eef92

Browse files
committed
docs(auth): correct isSignInWithEmailLink docs / note apiKey requirement
1 parent 7a145d2 commit 14eef92

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

packages/auth/lib/index.d.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2008,15 +2008,16 @@ export namespace FirebaseAuthTypes {
20082008
sendSignInLinkToEmail(email: string, actionCodeSettings?: ActionCodeSettings): Promise<void>;
20092009

20102010
/**
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
20122013
*
20132014
* #### Example
20142015
*
20152016
* ```js
2016-
* const signedInWithLink = await firebase.auth().isSignInWithEmailLink(link);
2017+
* const valid = await firebase.auth().isSignInWithEmailLink(link);
20172018
* ```
20182019
*
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
20202021
*/
20212022
isSignInWithEmailLink(emailLink: string): Promise<boolean>;
20222023

packages/auth/lib/modular/index.d.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,8 @@ export interface PopupRedirectResolver {}
165165
export function initializeRecaptchaConfig(auth: Auth): Promise<void>;
166166

167167
/**
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
169170
*
170171
* @param auth - The Auth instance.
171172
* @param emailLink - The email link to check.

0 commit comments

Comments
 (0)