restoreCollections - Product Module Reference

This documentation provides a reference to the restoreCollections method. This belongs to the Product Module.

This method is used to restore collections which were deleted using the softDelete method.

Example

await productModuleService.restoreCollections([
  "pcol_123",
  "pcol_321",
])

Parameters

collectionIdsstring[]Required

The IDs of the collections to restore.

configRestoreReturn<TReturnableLinkableKeys>

Configurations determining which relations to restore along with each of the collections. You can pass to its returnLinkableKeys property any of the collection'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. The object's keys are the ID attribute names of the product entity's relations. If there are no related records that were restored, the promise resolved to void.