@paystack/inline-js - npm Package Compare versions

Comparing version 2.22.0 to 2.22.1-dev.1

package.json

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

README.md

@@ -177,12 +177,21 @@ Public Docs
 
-# PaystackPop.resumeTransaction({options})
+# PaystackPop.resumeTransaction(accessCode, callbacks)
 
 This method resumes a transaction using the access code created on your server with [the Paystack API](https://developers.paystack.co/v1.0/reference#initialize-a-transaction). 
 
-### Configuration Options
+### Access Code Parameter
 
-| Option                        | Required       | Type                | Description                                                                   |
-| ----------------------------- | -------------- | --------------------| ----------------------------------------------------------------------------- |
-| accessCode                    | True           | `String`            | Access code created on the API via the [transaction/initialize](https://paystack.com/docs/#initialize-a-transaction) endpoint        |
+| Type           | Description                                                                                                                     |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------- |
+| `String`       | Access code created on the API via the [transaction/initialize](https://paystack.com/docs/#initialize-a-transaction) endpoint   |
 
+### Callback Definitions
+
+| Function Name        | Description                                         | Response Properties                                        |
+| -------------------- | ----------------------------------------------------| ---------------------------------------------------------- |
+| 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 successful 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 }`           |
+
 ## Method Response
@@ -189,0 +198,0 @@

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

513037

increased by37.4%

Lines of code

7738

increased by521.53%

Number of lines in readme file

460

increased by2%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes