@deep/nest-kit
Preparing search index...
modules/auth-n
IBaseAuthNResolverHost
Interface IBaseAuthNResolverHost<U, UR, RT>
interface
IBaseAuthNResolverHost
<
U
extends
BaseUser
,
UR
extends
BaseUserToRole
,
RT
extends
BaseRefreshToken
,
>
{
authNService
:
BaseAuthNService
<
U
,
UR
,
RT
>
;
createPasswordRecoveryRequest
(
input
:
SendPasswordRecoveryEmailInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
boolean
>
;
inviteUser
(
input
:
InviteUserInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
IInviteUserPayload
<
U
>
>
;
recoverPassword
(
input
:
RecoverPasswordInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
boolean
>
;
signIn
(
input
:
SignInInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
ISignInPayload
<
U
>
>
;
signInAsUser
(
input
:
SignInAsUserInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
SignInAsUserPayload
>
;
signOut
(
input
:
SignOutInput
,
ctx
:
IBaseActionContext
)
:
Promise
<
boolean
>
;
signOutAsUser
(
input
:
SignOutAsUserInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
SignOutAsUserPayload
>
;
signUp
(
input
:
SignUpInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
ISignUpPayload
<
U
>
>
;
verifyPasswordRecoveryToken
(
input
:
VerifyPasswordRecoveryInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
boolean
>
;
}
Type Parameters
U
extends
BaseUser
UR
extends
BaseUserToRole
RT
extends
BaseRefreshToken
Index
Properties
auth
N
Service
Methods
create
Password
Recovery
Request
invite
User
recover
Password
sign
In
sign
In
As
User
sign
Out
sign
Out
As
User
sign
Up
verify
Password
Recovery
Token
Properties
auth
N
Service
authNService
:
BaseAuthNService
<
U
,
UR
,
RT
>
Methods
create
Password
Recovery
Request
createPasswordRecoveryRequest
(
input
:
SendPasswordRecoveryEmailInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
boolean
>
Parameters
input
:
SendPasswordRecoveryEmailInput
ctx
:
IBaseActionContext
Returns
Promise
<
boolean
>
invite
User
inviteUser
(
input
:
InviteUserInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
IInviteUserPayload
<
U
>
>
Parameters
input
:
InviteUserInput
ctx
:
IBaseActionContext
Returns
Promise
<
IInviteUserPayload
<
U
>
>
recover
Password
recoverPassword
(
input
:
RecoverPasswordInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
boolean
>
Parameters
input
:
RecoverPasswordInput
ctx
:
IBaseActionContext
Returns
Promise
<
boolean
>
sign
In
signIn
(
input
:
SignInInput
,
ctx
:
IBaseActionContext
)
:
Promise
<
ISignInPayload
<
U
>
>
Parameters
input
:
SignInInput
ctx
:
IBaseActionContext
Returns
Promise
<
ISignInPayload
<
U
>
>
sign
In
As
User
signInAsUser
(
input
:
SignInAsUserInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
SignInAsUserPayload
>
Parameters
input
:
SignInAsUserInput
ctx
:
IBaseActionContext
Returns
Promise
<
SignInAsUserPayload
>
sign
Out
signOut
(
input
:
SignOutInput
,
ctx
:
IBaseActionContext
)
:
Promise
<
boolean
>
Parameters
input
:
SignOutInput
ctx
:
IBaseActionContext
Returns
Promise
<
boolean
>
sign
Out
As
User
signOutAsUser
(
input
:
SignOutAsUserInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
SignOutAsUserPayload
>
Parameters
input
:
SignOutAsUserInput
ctx
:
IBaseActionContext
Returns
Promise
<
SignOutAsUserPayload
>
sign
Up
signUp
(
input
:
SignUpInput
,
ctx
:
IBaseActionContext
)
:
Promise
<
ISignUpPayload
<
U
>
>
Parameters
input
:
SignUpInput
ctx
:
IBaseActionContext
Returns
Promise
<
ISignUpPayload
<
U
>
>
verify
Password
Recovery
Token
verifyPasswordRecoveryToken
(
input
:
VerifyPasswordRecoveryInput
,
ctx
:
IBaseActionContext
,
)
:
Promise
<
boolean
>
Parameters
input
:
VerifyPasswordRecoveryInput
ctx
:
IBaseActionContext
Returns
Promise
<
boolean
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
auth
N
Service
Methods
create
Password
Recovery
Request
invite
User
recover
Password
sign
In
sign
In
As
User
sign
Out
sign
Out
As
User
sign
Up
verify
Password
Recovery
Token
@deep/nest-kit
Loading...