softDeleteRegions - Region Module Reference

This documentation provides a reference to the softDeleteRegions method. This belongs to the Region 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 region by its IDs.

Example#

Code
1await regionModuleService.softDeleteRegions(["reg_123", "reg_321"], {2  returnLinkableKeys: ["country_id"],3})

Parameters#

regionIdsstring[]

The regions' IDs.

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.

Returns#

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

An object that includes the IDs of related records that were also soft deleted, such as the ID of the associated country. The object's keys are the ID attribute names of the region entity's relations, such as country_id, and its value is an array of strings, each being the ID of a record associated with the region through this relation, such as the IDs of associated countries. If there are no related records, the promise resolves to void.