deleteRegions - Region Module Reference

This documentation provides a reference to the deleteRegions 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.

deleteRegions(ids, sharedContext?): Promise<void>#

This method deletes regions by their IDs.

Code
await regionModuleService.deleteRegions(["reg_123", "reg_321"])

idsstring[]

The IDs of the region.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the regions are deleted.

This method deletes a region by its ID.

Code
await regionModuleService.deleteRegions("reg_123")

idstring

The ID of the region.

sharedContextContextOptional

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

PromisePromise<void>

Resolves when the region is deleted.

Was this page helpful?