medusa-store/docs/content/references/services/classes/UserService.md

Class: UserService

Provides layer to manipulate users.

Hierarchy

• TransactionBaseService

  ↳ UserService

Constructors

constructor

• new UserService(__namedParameters)

Parameters

Name	Type
__namedParameters	UserServiceProps

Overrides

TransactionBaseService.constructor

Defined in

packages/medusa/src/services/user.ts:41

Properties

__configModule__

• Protected Optional Readonly __configModule__: Record<string, unknown>

Inherited from

TransactionBaseService.__configModule__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:10

---

__container__

• Protected Readonly __container__: any

Inherited from

TransactionBaseService.__container__

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:9

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

packages/medusa/src/services/user.ts:39

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

packages/medusa/src/services/user.ts:36

---

transactionManager_

• Protected transactionManager_: EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

packages/medusa/src/services/user.ts:37

---

userRepository_

• Protected Readonly userRepository_: typeof UserRepository

Defined in

packages/medusa/src/services/user.ts:38

---

Events

▪ Static Events: Object

Type declaration

Name	Type
CREATED	string
DELETED	string
PASSWORD_RESET	string
UPDATED	string

Defined in

packages/medusa/src/services/user.ts:29

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.

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>	the 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<TResult>

the result of the transactional work

Inherited from

TransactionBaseService.atomicPhase_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:50

---

create

▸ create(user, password): Promise<User>

Creates a user with username being validated. Fails if email is not a valid format.

Parameters

Name	Type	Description
user	CreateUserInput	the user to create
password	string	user's password to hash

Returns

Promise<User>

the result of create

Defined in

packages/medusa/src/services/user.ts:157

---

delete

▸ delete(userId): Promise<void>

Deletes a user from a given user id.

Parameters

Name	Type	Description
userId	string	the id of the user to delete. Must be castable as an ObjectId

Returns

Promise<void>

the result of the delete operation.

Defined in

packages/medusa/src/services/user.ts:237

---

generateResetPasswordToken

▸ generateResetPasswordToken(userId): Promise<string>

Generate a JSON Web token, that will be sent to a user, that wishes to reset password. The token will be signed with the users current password hash as a secret a long side a payload with userId and the expiry time for the token, which is always 15 minutes.

Parameters

Name	Type	Description
userId	string	the id of the user to reset password for

Returns

Promise<string>

the generated JSON web token

Defined in

packages/medusa/src/services/user.ts:293

---

hashPassword_

▸ hashPassword_(password): Promise<string>

Hashes a password

Parameters

Name	Type	Description
password	string	the value to hash

Returns

Promise<string>

hashed password

Defined in

packages/medusa/src/services/user.ts:145

---

list

▸ list(selector, config?): Promise<User[]>

Parameters

Name	Type	Description
selector	FilterableUserProps	the query object for find
config	Object	the configuration object for the query

Returns

Promise<User[]>

the result of the find operation

Defined in

packages/medusa/src/services/user.ts:54

---

retrieve

▸ retrieve(userId, config?): Promise<User>

Gets a user by id. Throws in case of DB Error and if user was not found.

Parameters

Name	Type	Description
userId	string	the id of the user to get.
config	FindConfig<User>	query configs

Returns

Promise<User>

the user document.

Defined in

packages/medusa/src/services/user.ts:67

---

retrieveByApiToken

▸ retrieveByApiToken(apiToken, relations?): Promise<User>

Gets a user by api token. Throws in case of DB Error and if user was not found.

Parameters

Name	Type	Default value	Description
apiToken	string	undefined	the token of the user to get.
relations	string[]	[]	relations to include with the user

Returns

Promise<User>

the user document.

Defined in

packages/medusa/src/services/user.ts:91

---

retrieveByEmail

▸ retrieveByEmail(email, config?): Promise<User>

Gets a user by email. Throws in case of DB Error and if user was not found.

Parameters

Name	Type	Description
email	string	the email of the user to get.
config	FindConfig<User>	query config

Returns

Promise<User>

the user document.

Defined in

packages/medusa/src/services/user.ts:120

---

setPassword_

▸ setPassword_(userId, password): Promise<User>

Sets a password for a user Fails if no user exists with userId and if the hashing of the new password does not work.

Parameters

Name	Type	Description
userId	string	the userId to set password for
password	string	the old password to set

Returns

Promise<User>

the result of the update operation

Defined in

packages/medusa/src/services/user.ts:264

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

Name	Type
err	Record<string, unknown> | { code: string }

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:31

---

update

▸ update(userId, update): Promise<User>

Updates a user.

Parameters

Name	Type	Description
userId	string	id of the user to update
update	UpdateUserInput	the values to be updated on the user

Returns

Promise<User>

the result of create

Defined in

packages/medusa/src/services/user.ts:191

---

withTransaction

▸ withTransaction(transactionManager?): UserService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

UserService

Inherited from

TransactionBaseService.withTransaction

Defined in

packages/medusa/src/interfaces/transaction-base-service.ts:13