chore(core-flows,types,utils): fixes to TSDocs (#12692)

This commit is contained in:
Shahed Nasser
2025-06-10 18:33:41 +03:00
committed by GitHub
parent d8b196d6b1
commit 5ba842bfb0
4 changed files with 15 additions and 9 deletions

View File

@@ -40,9 +40,9 @@ const validateDraftOrdersStep = createStep(
export const deleteDraftOrderWorkflowId = "delete-draft-order"
/**
* This workflow deletes draft orders.
* This workflow deletes draft orders. It's used by the [Delete Draft Order API route](https://docs.medusajs.com/api/admin#draft-orders_deletedraftordersid).
*
* You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around canceling an order.
* You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around deleting a draft order.
*
* @example
* const { result } = await deleteDraftOrderWorkflow(container)
@@ -55,8 +55,6 @@ export const deleteDraftOrderWorkflowId = "delete-draft-order"
* @summary
*
* Delete draft orders.
*
* @property hooks.orderCanceled - This hook is executed after the order is canceled. You can consume this hook to perform custom actions on the canceled order.
*/
export const deleteDraftOrdersWorkflow = createWorkflow(
deleteDraftOrderWorkflowId,