@paystack/inline-js - npm Package Compare versions

Comparing version 2.22.1-dev.2 to 2.22.1-dev.3

package.json

 {
   "name": "@paystack/inline-js",
-  "version": "2.22.1-dev.2",
+  "version": "2.22.1-dev.3",
   "description": "Client-side library to load the Paystack checkout form",
@@ -5,0 +5,0 @@ "main": "lib/inline.js",

README.md

@@ -116,11 +116,12 @@ Public Docs
 
-| Function Name           | Description                                         | Function Parameters                                        |
-| -------------------- | ----------------------------------------------------| ---------------------------------------------------------- |
-| onError              | Called when the transaction was not successfully loaded                                     | `{ message: "error message from API" }`   |
-| onCancel             | Called when the customer cancels the transaction                                            |   |
-| onLoad               | Called when the transaction is successfully loaded and the customer can see the checkout form | `{ id: "transaction id from API", customer: "customer object from API", accessCode: "transaction access code" }`           |
-| onSuccess            | Called when the customer successfully completes a transaction | `{ id: "transaction id from API", reference: "transaction reference", message: "message from API" }`           |
+| Function Name              | Description                                         | Function Parameters                                        |  Function Parameter Definitions |
+| -------------------------- | ----------------------------------------------------| ---------------------------------------------------------- |  ------------------------------ |
+| onError                    | Called when the transaction was not successfully loaded                                     | `{ message: string }`   |   `message`: Message from API |
+| onCancel                   | Called when the customer cancels the transaction                                            |  `undefined` |  N/A |
+| onLoad                     | Called when the transaction is successfully loaded and the customer can see the checkout form | `{ id: number, customer: Object, accessCode: string }` | `id`: Transaction ID from API <br> `customer`: Customer object from API <br> `accessCode`: Transaction access code  |
+| onSuccess                  | Called when the customer successfully completes a transaction | `{ id: number, reference: string, message: string }`  | `id`: Transaction ID from API <br> `message`: Message from API <br> `reference`: Transaction reference   |
 
 
 
+
 ### Configuration Options for Split Payments
@@ -190,8 +191,8 @@
 
-| Function Name              | Description                                         | Callback Parameters                                        |
-| -------------------------- | ----------------------------------------------------| ---------------------------------------------------------- |
-| onError                    | Called when the transaction was not successfully loaded                                     | `{ message: "error message from API" }`   |
-| onCancel                   | Called when the customer cancels the transaction                                            |   |
-| onLoad                     | Called when the transaction is successfully loaded and the customer can see the checkout form | `{ id: "transaction id from API", customer: "customer object from API", accessCode: "transaction access code" }`           |
-| onSuccess                  | Called when the customer successfully completes a transaction | `{ id: "transaction id from API", reference: "transaction reference", message: "message from API" }`           |
+| Function Name              | Description                                         | Callback Parameters                                        |  Callback Parameter Definitions |
+| -------------------------- | ----------------------------------------------------| ---------------------------------------------------------- |  ------------------------------ |
+| onError                    | Called when the transaction was not successfully loaded                                     | `{ message: string }`   |   `message`: Message from API |
+| onCancel                   | Called when the customer cancels the transaction                                            |  `undefined` |  N/A |
+| onLoad                     | Called when the transaction is successfully loaded and the customer can see the checkout form | `{ id: number, customer: Object, accessCode: string }` | `id`: Transaction ID from API <br> `customer`: Customer object from API <br> `accessCode`: Transaction access code  |
+| onSuccess                  | Called when the customer successfully completes a transaction | `{ id: number, reference: string, message: string }`  | `id`: Transaction ID from API <br> `message`: Message from API <br> `reference`: Transaction reference   |
 
@@ -198,0 +199,0 @@ ## Method Response

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

513542

increased by0.08%

Number of lines in readme file

461

increased by0.22%

No dependency changes