add links to docs for type BackstageSignInResult

Signed-off-by: Hasan Ozdemir <21654050+nodify-at@users.noreply.github.com>
This commit is contained in:
Hasan Ozdemir
2021-12-11 01:45:39 +01:00
parent e0c63b37db
commit 133769ea84
3 changed files with 2 additions and 4 deletions
-2
View File
@@ -549,8 +549,6 @@ export type OidcAuthResult = {
userinfo: UserinfoResponse;
};
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@BackstageSignInResult" is not defined in this configuration
//
// @public
export type OidcProviderOptions = {
authHandler?: AuthHandler<OidcAuthResult>;
@@ -233,7 +233,7 @@ export const oAuth2DefaultSignInResolver: SignInResolver<OidcAuthResult> =
* can be passed while creating a OIDC provider.
*
* authHandler : called after sign in was successful, a new object must be returned which includes a profile
* signInResolver: called after sign in was successful, expects to return a new @BackstageSignInResult
* signInResolver: called after sign in was successful, expects to return a new {@link BackstageSignInResult}
*
* Both options are optional. There is fallback for authHandler where the default handler expect an e-mail explicitly
* otherwise it throws an error
+1 -1
View File
@@ -258,7 +258,7 @@ export type SignInInfo<AuthResult> = {
/**
* Sign in resolver type describes the function which handles the result of a successful authentication
* and must return a valid BackStageSignInResult
* and it must return a valid {@link BackstageSignInResult}
* @public
*/
export type SignInResolver<AuthResult> = (