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

Class: UserService

Hierarchy

• TransactionBaseService<UserService>

  ↳ UserService

Constructors

constructor

• new UserService(__namedParameters)

Parameters

Name	Type
__namedParameters	UserServiceProps

Overrides

TransactionBaseService<UserService&gt;.constructor

Defined in

services/user.ts:37

Properties

configModule

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

Inherited from

TransactionBaseService.configModule

---

container

• Protected Readonly container: unknown

Inherited from

TransactionBaseService.container

---

eventBus_

• Protected Readonly eventBus_: EventBusService

Defined in

services/user.ts:35

---

manager_

• Protected manager_: EntityManager

Overrides

TransactionBaseService.manager_

Defined in

services/user.ts:32

---

transactionManager_

• Protected transactionManager_: EntityManager

Overrides

TransactionBaseService.transactionManager_

Defined in

services/user.ts:33

---

userRepository_

• Protected Readonly userRepository_: typeof UserRepository

Defined in

services/user.ts:34

---

Events

▪ Static Events: Object

Type declaration

Name	Type
PASSWORD_RESET	string

Defined in

services/user.ts:28

Methods

atomicPhase_

▸ Protected atomicPhase_<TResult, TError>(work, isolationOrErrorHandler?, maybeErrorHandlerOrDontFail?): Promise<TResult>

Type parameters

Name
TResult
TError

Parameters

Name	Type	Description
work	(transactionManager: EntityManager) => Promise<TResult>
isolationOrErrorHandler?	IsolationLevel | (error: TError) => Promise<void | TResult>
maybeErrorHandlerOrDontFail?	(error: TError) => Promise<void | TResult>

Returns

Promise<TResult>

Inherited from

TransactionBaseService.atomicPhase_

Defined in

interfaces/transaction-base-service.ts:53

---

create

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

Parameters

Name	Type	Description
user	CreateUserInput
password	string

Returns

Promise<User>

Defined in

services/user.ts:183

---

delete

▸ delete(userId): Promise<void>

Parameters

Name	Type	Description
userId	string

Returns

Promise<void>

Defined in

services/user.ts:251

---

generateResetPasswordToken

▸ generateResetPasswordToken(userId): Promise<string>

Parameters

Name	Type	Description
userId	string

Returns

Promise<string>

Defined in

services/user.ts:305

---

hashPassword_

▸ hashPassword_(password): Promise<string>

Parameters

Name	Type	Description
password	string

Returns

Promise<string>

Defined in

services/user.ts:171

---

list

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

Parameters

Name	Type	Description
selector	FilterableUserProps
config	Object

Returns

Promise<User[]>

Defined in

services/user.ts:68

---

retrieve

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

Parameters

Name	Type	Description
userId	string
config	FindConfig<User>

Returns

Promise<User>

Defined in

services/user.ts:84

---

retrieveByApiToken

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

Parameters

Name	Type	Default value	Description
apiToken	string	undefined
relations	string[]	[]

Returns

Promise<User>

Defined in

services/user.ts:111

---

retrieveByEmail

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

Parameters

Name	Type	Description
email	string
config	FindConfig<User>

Returns

Promise<User>

Defined in

services/user.ts:143

---

setPassword_

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

Parameters

Name	Type	Description
userId	string
password	string

Returns

Promise<User>

Defined in

services/user.ts:276

---

shouldRetryTransaction_

▸ Protected shouldRetryTransaction_(err): boolean

Parameters

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

Returns

boolean

Inherited from

TransactionBaseService.shouldRetryTransaction_

Defined in

interfaces/transaction-base-service.ts:34

---

update

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

Parameters

Name	Type	Description
userId	string
update	UpdateUserInput

Returns

Promise<User>

Defined in

services/user.ts:211

---

validateEmail_

▸ validateEmail_(email): string

Parameters

Name	Type	Description
email	string

Returns

string

Defined in

services/user.ts:50

---

withTransaction

▸ withTransaction(transactionManager?): UserService

Parameters

Name	Type
transactionManager?	EntityManager

Returns

UserService

Inherited from

TransactionBaseService.withTransaction

Defined in

interfaces/transaction-base-service.ts:16