diff --git a/src/global.ts b/src/global.ts index 1ec7ca321..f3ee6158a 100644 --- a/src/global.ts +++ b/src/global.ts @@ -305,12 +305,21 @@ export interface RedirectLoginOptions * * @example * const client = new Auth0Client({ - * async openUrl(url) { + * openUrl(url) { * window.location.replace(url); * } * }); + * + * @example + * import { Browser } from '@capacitor/browser'; + * + * const client = new Auth0Client({ + * async openUrl(url) { + * await Browser.open({ url }); + * } + * }); */ - openUrl?: (url: string) => Promise; + openUrl?: (url: string) => Promise | void; } export interface RedirectLoginResult { @@ -466,12 +475,21 @@ export interface LogoutOptions extends LogoutUrlOptions { * * @example * await auth0.logout({ - * async openUrl(url) { + * openUrl(url) { * window.location.replace(url); * } * }); + * + * @example + * import { Browser } from '@capacitor/browser'; + * + * await auth0.logout({ + * async openUrl(url) { + * await Browser.open({ url }); + * } + * }); */ - openUrl?: false | ((url: string) => Promise); + openUrl?: false | ((url: string) => Promise | void); } /**