Interface AuthControllerInterface<CredentialsType, AuthDataType, RefreshLoginDataType, RequestPasswordResetDataType, ConfirmPasswordResetDataType>

Interface for an auth controller.

interface AuthControllerInterface<
    CredentialsType,
    AuthDataType,
    RefreshLoginDataType,
    RequestPasswordResetDataType,
    ConfirmPasswordResetDataType,
> {
    confirmPasswordReset: (
        data: ConfirmPasswordResetDataType,
    ) => Promise<void>;
    login: (credentials: CredentialsType) => Promise<AuthDataType>;
    refreshLogin: (data: RefreshLoginDataType) => Promise<AuthDataType>;
    requestPasswordReset: (data: RequestPasswordResetDataType) => Promise<void>;
}

Type Parameters

CredentialsType
AuthDataType
RefreshLoginDataType
RequestPasswordResetDataType
ConfirmPasswordResetDataType

Implemented by

JwtAuthController

Index

Properties

confirmPasswordReset login refreshLogin requestPasswordReset

Properties

confirmPasswordReset

confirmPasswordReset: (data: ConfirmPasswordResetDataType) => Promise<void>

Confirms a new password for a user using the provided confirm password reset data.

login

login: (credentials: CredentialsType) => Promise<AuthDataType>

Logs in a user.

refreshLogin

refreshLogin: (data: RefreshLoginDataType) => Promise<AuthDataType>

Refreshes the login of a user.

requestPasswordReset

requestPasswordReset: (data: RequestPasswordResetDataType) => Promise<void>

Request a new password for a user using the request password reset data.