restore - Region Module Reference

This documentation provides a reference to the restore method. This belongs to the Region Module.

This method restores soft deleted regions by their IDs.

Example

await regionModuleService.restore(["reg_123", "reg_321"], {
  returnLinkableKeys: ["country_id"],
})

Parameters

regionIdsstring[]Required

The regions' IDs.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the region. You can pass to its returnLinkableKeys property any of the region's relation attribute names, such as countries.

sharedContextContext

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

Returns

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

An object that includes the IDs of related records that were restored, such as the ID of associated countries. 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 the record associated with the region through this relation, such as the IDs of associated countries. If there are no related records restored, the promise resolves to void.