Skip to main content

AccountsMikroOrm <CustomUser, CustomEmail, CustomSession, CustomService>

Implements

DatabaseInterface

Constructors

constructor

new AccountsMikroOrm<CustomUser, CustomEmail, CustomSession, CustomService>(EmailEntity?: Constructor<CustomEmail | Email<any>>, ServiceEntity?: Constructor<CustomService | Service<any>>, SessionEntity?: Constructor<CustomSession | Session<any>>, UserEntity?: Constructor<CustomUser | IUser<any, any, any>>): AccountsMikroOrm<CustomUser, CustomEmail, CustomSession, CustomService>

Type parameters
- CustomUser: IUser<any, any, any>
- CustomEmail: Email<any>
- CustomSession: Session<any>
- CustomService: Service<any>
Parameters
- optionalEmailEntity: Constructor<CustomEmail | Email<any>>
- optionalServiceEntity: Constructor<CustomService | Service<any>>
- optionalSessionEntity: Constructor<CustomSession | Session<any>>
- optionalUserEntity: Constructor<CustomUser | IUser<any, any, any>>
Returns AccountsMikroOrm<CustomUser, CustomEmail, CustomSession, CustomService>

Methods

publicaddEmail

addEmail(userId: string, newEmail: string, verified: boolean): Promise<void>

Implementation of DatabaseInterface.addEmail
Parameters
- userId: string
- newEmail: string
- verified: boolean
Returns Promise<void>

publicaddEmailVerificationToken

addEmailVerificationToken(userId: string, email: string, token: string): Promise<void>

Implementation of DatabaseInterface.addEmailVerificationToken
Parameters
- userId: string
- email: string
- token: string
Returns Promise<void>

publicaddLoginToken

addLoginToken(userId: string, email: string, token: string): Promise<void>

Implementation of DatabaseInterface.addLoginToken
Parameters
- userId: string
- email: string
- token: string
Returns Promise<void>

publicaddResetPasswordToken

addResetPasswordToken(userId: string, email: string, token: string, reason: string): Promise<void>

Implementation of DatabaseInterface.addResetPasswordToken
Parameters
- userId: string
- email: string
- token: string
- reason: string
Returns Promise<void>

publiccreateSession

createSession(userId: string, token: string, connection?: ConnectionInformations, extra?: object): Promise<string>

Implementation of DatabaseInterface.createSession
Parameters
- userId: string
- token: string
- connection: ConnectionInformations = {}
- optionalextra: object
Returns Promise<string>

publiccreateUser

createUser(__namedParameters: CreateUser): Promise<string>

Implementation of DatabaseInterface.createUser
Parameters
- __namedParameters: CreateUser
Returns Promise<string>

publicfindPasswordHash

findPasswordHash(userId: string): Promise<null | string>

Implementation of DatabaseInterface.findPasswordHash
Parameters
- userId: string
Returns Promise<null | string>

publicfindSessionById

findSessionById(sessionId: string): Promise<null | Session>

Implementation of DatabaseInterface.findSessionById
Parameters
- sessionId: string
Returns Promise<null | Session>

publicfindSessionByToken

findSessionByToken(token: string): Promise<null | Session>

Implementation of DatabaseInterface.findSessionByToken
Parameters
- token: string
Returns Promise<null | Session>

publicfindUserByEmail

findUserByEmail(email: string): Promise<null | User>

Implementation of DatabaseInterface.findUserByEmail
Parameters
- email: string
Returns Promise<null | User>

publicfindUserByEmailVerificationToken

findUserByEmailVerificationToken(token: string): Promise<null | User>

Implementation of DatabaseInterface.findUserByEmailVerificationToken
Parameters
- token: string
Returns Promise<null | User>

publicfindUserById

findUserById(userId: string): Promise<null | User>

Implementation of DatabaseInterface.findUserById
Parameters
- userId: string
Returns Promise<null | User>

publicfindUserByLoginToken

findUserByLoginToken(token: string): Promise<null | User>

Implementation of DatabaseInterface.findUserByLoginToken
Parameters
- token: string
Returns Promise<null | User>

publicfindUserByResetPasswordToken

findUserByResetPasswordToken(token: string): Promise<null | User>

Implementation of DatabaseInterface.findUserByResetPasswordToken
Parameters
- token: string
Returns Promise<null | User>

publicfindUserByServiceId

findUserByServiceId(serviceName: string, serviceId: string): Promise<null | User>

Implementation of DatabaseInterface.findUserByServiceId
Parameters
- serviceName: string
- serviceId: string
Returns Promise<null | User>

publicfindUserByUsername

findUserByUsername(username: string): Promise<null | User>

Implementation of DatabaseInterface.findUserByUsername
Parameters
- username: string
Returns Promise<null | User>

publicinvalidateAllSessions

invalidateAllSessions(userId: string, excludedSessionIds?: string[]): Promise<void>

Implementation of DatabaseInterface.invalidateAllSessions
Parameters
- userId: string
- optionalexcludedSessionIds: string[]
Returns Promise<void>

publicinvalidateSession

invalidateSession(sessionId: string): Promise<void>

Implementation of DatabaseInterface.invalidateSession
Parameters
- sessionId: string
Returns Promise<void>

publicremoveAllLoginTokens

removeAllLoginTokens(userId: string): Promise<void>

Implementation of DatabaseInterface.removeAllLoginTokens
Parameters
- userId: string
Returns Promise<void>

publicremoveAllResetPasswordTokens

removeAllResetPasswordTokens(userId: string): Promise<void>

Implementation of DatabaseInterface.removeAllResetPasswordTokens
Parameters
- userId: string
Returns Promise<void>

publicremoveEmail

removeEmail(userId: string, email: string): Promise<void>

Implementation of DatabaseInterface.removeEmail
Parameters
- userId: string
- email: string
Returns Promise<void>

publicsetPassword

setPassword(userId: string, newPassword: string, flush?: boolean): Promise<void>

Implementation of DatabaseInterface.setPassword
Parameters
- userId: string
- newPassword: string
- flush: boolean = true
Returns Promise<void>

publicsetResetPassword

setResetPassword(userId: string, email: string, newPassword: string): Promise<void>

Parameters
- userId: string
- email: string
- newPassword: string
Returns Promise<void>

publicsetService

setService(userId: string, serviceName: string, data: object, token?: string, flush?: boolean): Promise<void>

Implementation of DatabaseInterface.setService
Parameters
- userId: string
- serviceName: string
- data: object
- optionaltoken: string
- flush: boolean = true
Returns Promise<void>

publicsetUserDeactivated

setUserDeactivated(userId: string, deactivated: boolean): Promise<void>

Implementation of DatabaseInterface.setUserDeactivated
Parameters
- userId: string
- deactivated: boolean
Returns Promise<void>

publicsetUsername

setUsername(userId: string, newUsername: string): Promise<void>

Implementation of DatabaseInterface.setUsername
Parameters
- userId: string
- newUsername: string
Returns Promise<void>

publicunsetService

unsetService(userId: string, serviceName: string): Promise<void>

Implementation of DatabaseInterface.unsetService
Parameters
- userId: string
- serviceName: string
Returns Promise<void>

publicupdateSession

updateSession(sessionId: string, connection: ConnectionInformations): Promise<void>

Implementation of DatabaseInterface.updateSession
Parameters
- sessionId: string
- connection: ConnectionInformations
Returns Promise<void>

publicverifyEmail

verifyEmail(userId: string, email: string): Promise<void>

Implementation of DatabaseInterface.verifyEmail
Parameters
- userId: string
- email: string
Returns Promise<void>