restore - Store Module Reference

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

This method restores a soft deleted store by its IDs.

Example

await storeModuleService.restore(["store_123", "store_321"])

Parameters

storeIdsstring[]Required

The IDs of the stores.

configRestoreReturn<TReturnableLinkableKeys>

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

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. If there are no related records restored, the promise resolves to void.