Skip to content

fix: fixes signInFailure return type #812

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 4, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* Fixes `signInFailure` return type to also include void to match external documentation. Fixes
https://github.com/firebase/firebaseui-web/issues/770
4 changes: 2 additions & 2 deletions externs/firebaseui-externs.js
Original file line number Diff line number Diff line change
Expand Up @@ -674,8 +674,8 @@ firebaseui.auth.Callbacks.prototype.signInSuccessWithAuthResult =
*
* @param {!firebaseui.auth.AuthUIError} error The FirebaseUI error identifying
* the reason behind the failure.
* @return {!Promise<void>} A promise that resolves when the merge conflict
* is completed.
* @return {!Promise<void>|void} Either void or a promise that resolves when the
* merge conflict is completed.
*/
firebaseui.auth.Callbacks.prototype.signInFailure = function(error) {};

Expand Down
2 changes: 1 addition & 1 deletion types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ interface Callbacks {
authResult: any,
redirectUrl?: string
): boolean;
signInFailure?(error: firebaseui.auth.AuthUIError): Promise<void>;
signInFailure?(error: firebaseui.auth.AuthUIError): Promise<void>|void;
uiShown?(): void;
}

Expand Down