restore Method - Service Factory Reference

This method of a module's service restores one or more records of a data model that were soft-deleted.

The method's name is of the format restoreDataModel, where DataModel is the plural pascal-case name of the data model.

Restore One Record#

Code
const restoredPosts = await postModuleService.restorePosts("123")

Parameters#

To restore one record, pass its ID as a parameter to the method.

Returns#

The method returns an object, whose keys are of the format {camel_case_data_model_name}_id, and their values are arrays of restored records' IDs.

For example, the returned object of the above example is:

Code
1{2  "post_id": ["123"],3}

Restore Multiple Records#

Code
1const restoredPosts = await postModuleService.restorePosts([2  "123",3  "321",4])

Parameters#

To restore multiple records, pass an array of IDs as a parameter to the method.

Returns#

The method returns an object, whose keys are of the format {camel_case_data_model_name}_id, and their values are arrays of restored records' IDs.

For example, the returned object of the above example is:

Code
1{2  "post_id": [3    "123",4    "321",5  ],6}

Restore Records Matching Filters#

Code
1const restoredPosts = await postModuleService.restorePosts({2  name: "My Post",3})

Parameters#

To restore records matching a set of filters, pass an object of filters as a parameter to the method.

Returns#

The method returns an object, whose keys are of the format {camel_case_data_model_name}_id, and their values are arrays of restored records' IDs.

For example, the returned object of the above example is:

Code
1{2  "post_id": [3    "123",4  ],5}