Clarify Callback Usage in usePaystackPayment Hook Documentation#118
Open
Chimaobi098 wants to merge 1 commit intoiamraphson:masterfrom
Open
Clarify Callback Usage in usePaystackPayment Hook Documentation#118Chimaobi098 wants to merge 1 commit intoiamraphson:masterfrom
Chimaobi098 wants to merge 1 commit intoiamraphson:masterfrom
Conversation
Owner
|
I think it is better to update the documentation. |
aayodejii
approved these changes
May 9, 2025
Author
I completely agree. This PR only updates the README to clarify that the success and close callbacks must be passed as an object. |
2kama
approved these changes
Nov 3, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the documentation for the usePaystackPayment hook to clarify that the success and close callbacks must be passed as an object, i.e. using initializePayment({ onSuccess, onClose }) rather than as separate arguments i.e. initializePayment(onSuccess, onClose).
I initially tried using the separate arguments approach, but the callbacks weren’t being recognized and the onSuccess function was never fired even though the transaction was successful. After some investigation, I discovered that wrapping the callbacks in curly braces (to pass them as an object) resolved the issue.
This update should improve clarity and help prevent confusion for developers using this hook. Please review and let me know if any further adjustments are needed.