updateUsers - User Module Reference

This documentation provides a reference to the updateUsers method. This belongs to the User Module.

Note: You should only use this methods when implementing complex customizations. For common cases, check out available workflows instead.

updateUsers(data, sharedContext?): Promise<UserDTO[]>#

This method updates existing users.

Example#

Code
1const users = await userModuleService.updateUsers([2  {3    id: "user_123",4    first_name: "John"5  },6  {7    id: "user_321",8    last_name: "Doe"9  }10])

Parameters#

dataUpdateUserDTO[]

The attributes to update in the users.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<UserDTO[]>

The updated users.

updateUsers(data, sharedContext?): Promise<UserDTO>#

This method updates an existing user.

Example#

Code
1const user = await userModuleService.updateUsers({2  id: "user_123",3  first_name: "John"4})

Parameters#

dataUpdateUserDTO

The attributes to update in the user.

sharedContextContextOptional

A context used to share resources, such as transaction manager, between the application and the module.

Returns#

PromisePromise<UserDTO>

The updated user.

Was this page helpful?