Merge pull request #2 from andreagostinho-meli/docs/update-amount

Update amount documentation
mercadopago · Aug 16, 2023 · 76742fa · 76742fa
2 parents e22d5a6 + 18ffbb5
commit 76742fa
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@mercadopago/sdk-react",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Mercado Pago SDK React",
   "main": "index.js",
   "keywords": [

diff --git a/src/@types/global.d.ts b/src/@types/global.d.ts
@@ -8,11 +8,21 @@ declare global {
     MercadoPago: any;
     paymentBrickController: {
       unmount: () => void;
+      /**
+       * Updates data in Payment Brick preserving the current instance.
+       *
+       * @see {@link https://www.mercadopago.com/developers/en/docs/checkout-bricks/payment-brick/additional-customization/update-data Payment Brick # Default rendering} documentation.
+       */
       update: (updateValues: UpdateValues) => boolean;
     };
     cardPaymentBrickController: {
       unmount: () => void;
       getFormData: () => Promise<void>;
+      /**
+       * Updates data in Card Payment Brick preserving the current instance.
+       *
+       * @see {@link https://www.mercadopago.com/developers/en/docs/checkout-bricks/card-payment-brick/additional-customization/update-data Payment Brick # Default rendering} documentation.
+       */
       update: (updateValues: UpdateValues) => boolean;
     };
     walletBrickController: {

diff --git a/src/bricks/util/types/common.ts b/src/bricks/util/types/common.ts
@@ -153,6 +153,9 @@ export interface IBrickCustomVariables {
   formPadding?: string;
 }
 
+/**
+ * Available update values.
+ */
 export type UpdateValues = {
   amount: number;
 };