AuthService
Can authenticate a user based on email password combination
constructor
Parameters
__namedParameters
InjectedDependenciesRequiredProperties
manager_
EntityManagerRequiredtransactionManager_
undefined | EntityManagerRequired__container__
anyRequired__configModule__
Record<string, unknown>__moduleDeclaration__
Record<string, unknown>Accessors
activeManager_
Returns
EntityManager
EntityManagerRequiredMethods
withTransaction
Parameters
transactionManager
EntityManagerReturns
this
thisRequiredshouldRetryTransaction_
Parameters
err
Record<string, unknown> | objectRequiredReturns
boolean
booleanRequiredatomicPhase_
Wraps some work within a transactional block. If the service already has a transaction manager attached this will be reused, otherwise a new transaction manager is created.
Type Parameters
TResult
objectRequiredTError
objectRequiredParameters
work
(transactionManager: EntityManager) => Promise<TResult>Requiredthe transactional work to be done
isolationOrErrorHandler
IsolationLevel | (error: TError) => Promise<void | TResult>the isolation level to be used for the work.
maybeErrorHandlerOrDontFail
(error: TError) => Promise<void | TResult>Potential error handler
Returns
Promise
Promise<TResult>Requiredthe result of the transactional work
comparePassword_
Verifies if a password is valid given the provided password hash
Parameters
password
stringRequiredthe raw password to check
hash
stringRequiredthe hash to compare against
Returns
Promise
Promise<boolean>Requiredthe result of the comparison
authenticateAPIToken
Authenticates a given user with an API token
Parameters
token
stringRequiredthe api_token of the user to authenticate
Returns
Promise
Promise<AuthenticateResult>Requiredsuccess: whether authentication succeeded
user: the user document if authentication succeeded
error: a string with the error message
authenticate
Authenticates a given user based on an email, password combination. Uses scrypt to match password with hashed value.
Parameters
email
stringRequiredthe email of the user
password
stringRequiredthe password of the user
Returns
Promise
Promise<AuthenticateResult>Requiredsuccess: whether authentication succeeded
user: the user document if authentication succeeded
error: a string with the error message
authenticateCustomer
Authenticates a customer based on an email, password combination. Uses scrypt to match password with hashed value.
Parameters
email
stringRequiredthe email of the user
password
stringRequiredthe password of the user
Returns
Promise
Promise<AuthenticateResult>Requiredsuccess: whether authentication succeeded
customer: the customer document if authentication succeded
error: a string with the error message
Was this section helpful?