softDeleteUsers - User Module Reference

This documentation provides a reference to the softDeleteUsers 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.

This method soft deletes a user by its IDs.

Example#

Code
1await userModuleService.softDeleteUsers([2  "user_123", "user_321"3])

userIdsstring[]

The IDs of users to soft-delete

configSoftDeleteReturn<TReturnableLinkableKeys>Optional

An object that is used to specify an entity's related entities that should be soft-deleted when the main entity is soft-deleted.

sharedContextContextOptional

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

PromisePromise<void | Record<TReturnableLinkableKeys, string[]>>

An object that includes the IDs of related records that were also soft deleted. If there are no related records, the promise resolves to void.

Was this page helpful?