AuthService
Can authenticate a user based on email password combination
Hierarchy
TransactionBaseService↳
AuthService
Constructors
constructor
new AuthService(«destructured»)
Parameters
| Name |
|---|
«destructured» |
Overrides
TransactionBaseService.constructor
Defined in
medusa/src/services/auth.ts:22
Properties
__configModule__
Protected Optional Readonly __configModule__: Record<string, unknown>
Inherited from
TransactionBaseService.__configModule__
Defined in
medusa/src/interfaces/transaction-base-service.ts:14
__container__
Protected Readonly __container__: any
Inherited from
TransactionBaseService.__container__
Defined in
medusa/src/interfaces/transaction-base-service.ts:13
__moduleDeclaration__
Protected Optional Readonly __moduleDeclaration__: Record<string, unknown>
Inherited from
TransactionBaseService.__moduleDeclaration__
Defined in
medusa/src/interfaces/transaction-base-service.ts:15
customerService_
Protected Readonly customerService_: CustomerService
Defined in
medusa/src/services/auth.ts:20
manager_
Protected manager_: EntityManager
Inherited from
TransactionBaseService.manager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:5
transactionManager_
Protected transactionManager_: undefined | EntityManager
Inherited from
TransactionBaseService.transactionManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:6
userService_
Protected Readonly userService_: UserService
Defined in
medusa/src/services/auth.ts:19
Accessors
activeManager_
Protected get activeManager_(): EntityManager
Returns
EntityManager
-EntityManager:
Inherited from
TransactionBaseService.activeManager_
Defined in
medusa/src/interfaces/transaction-base-service.ts:8
Methods
atomicPhase_
Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>
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.
| Name |
|---|
TResult |
TError |
Parameters
| Name | Description |
|---|---|
work | (transactionManager: EntityManager) => Promise<TResult> |
isolationOrErrorHandler? | IsolationLevel | (error: TError) => Promise<void | TResult> |
maybeErrorHandlerOrDontFail? | (error: TError) => Promise<void | TResult> |
Returns
Promise<TResult>
-Promise: the result of the transactional work
Inherited from
TransactionBaseService.atomicPhase_
Defined in
medusa/src/interfaces/transaction-base-service.ts:56
authenticate
authenticate(email, password): Promise<AuthenticateResult>
Authenticates a given user based on an email, password combination. Uses scrypt to match password with hashed value.
Parameters
| Name | Description |
|---|---|
email | string |
password | string |
Returns
Promise<AuthenticateResult>
-Promise: success: whether authentication succeeded
user: the user document if authentication succeeded
error: a string with the error message
Defined in
medusa/src/services/auth.ts:81
authenticateAPIToken
authenticateAPIToken(token): Promise<AuthenticateResult>
Authenticates a given user with an API token
Parameters
| Name | Description |
|---|---|
token | string |
Returns
Promise<AuthenticateResult>
-Promise: success: whether authentication succeeded
user: the user document if authentication succeeded
error: a string with the error message
Defined in
medusa/src/services/auth.ts:52
authenticateCustomer
authenticateCustomer(email, password): Promise<AuthenticateResult>
Authenticates a customer based on an email, password combination. Uses scrypt to match password with hashed value.
Parameters
| Name | Description |
|---|---|
email | string |
password | string |
Returns
Promise<AuthenticateResult>
-Promise: success: whether authentication succeeded
customer: the customer document if authentication succeded
error: a string with the error message
Defined in
medusa/src/services/auth.ts:130
comparePassword_
Protected comparePassword_(password, hash): Promise<boolean>
Verifies if a password is valid given the provided password hash
Parameters
| Name | Description |
|---|---|
password | string |
hash | string |
Returns
Promise<boolean>
-Promise: the result of the comparison
-boolean: (optional)
Defined in
medusa/src/services/auth.ts:36
shouldRetryTransaction_
Protected shouldRetryTransaction_(err): boolean
Parameters
| Name |
|---|
err |
Returns
boolean
-boolean: (optional)
Inherited from
TransactionBaseService.shouldRetryTransaction_
Defined in
medusa/src/interfaces/transaction-base-service.ts:37
withTransaction
withTransaction(transactionManager?): AuthService
Parameters
| Name |
|---|
transactionManager? |
Returns
-AuthService:
Inherited from
TransactionBaseService.withTransaction