docs: apply suggestions from code review

Co-authored-by: Shahed Nasser <[email protected]>
medusajs · Dec 31, 2024 · b421df3 · b421df3
1 parent b4f1123
commit b421df3
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/packages/core/utils/src/fulfillment/provider.ts b/packages/core/utils/src/fulfillment/provider.ts
@@ -229,20 +229,21 @@ export class AbstractFulfillmentProviderService
    * @returns The calculated price's details.
    *
    * @example
+   * import { CalculateShippingOptionPriceDTO } from "@medusajs/framework/types"
    * class MyFulfillmentProviderService extends AbstractFulfillmentProviderService {
    *   // ...
    *   async calculatePrice(
-   *     optionData: Record<string, unknown>,
-   *     data: Record<string, unknown>,
-   *     context: any
+   *     optionData: CalculateShippingOptionPriceDTO["optionData"],
+   *     data: CalculateShippingOptionPriceDTO["data"],
+   *     context: CalculateShippingOptionPriceDTO["context"]
    *   ): Promise<CalculatedShippingOptionPrice> {
    *     // assuming the client can calculate the price using
    *     // the third-party service
    *     const price = await this.client.calculate(data)
    *     return {
    *       calculated_amount: price,
-   *       is_calculated_price_tax_inclusive: true,
    *       // Update this boolean value based on your logic
+   *       is_calculated_price_tax_inclusive: true,
    *     }
    *   }
    * }