This repository has been archived by the owner on Aug 16, 2024. It is now read-only.
useConnect: Make connect function undefined until connector is ready #60
Conversation
This file contains 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
Let `connection` function be `undefined` if `connector` is. This prevents the function from being called before `WalletConnectionProps.activeConnector` is ready which would fail anyway. The expectation before was that the button/function invoking `connect` would check this itself, but making it explicit in the type seems less error-prone. I do not really consider this a breaking change because the type is being strictly expanded (to include `undefined`) and doesn't break any existing correct code. If one did pass the `connect` function to other functions (which would be weird), the type signatures of those functions might have to be updated though. An alternative solution would be to return an additional boolean `isReadyToConnect`, but that would not allow the type system to prevent the call like it does with this one.
bisgardo
force-pushed
the
react-components/nullable-connect
branch
from
e62c133 to
df59b98
Compare
Also "migrated" the samples though no migration was strictly necessary.
DOBEN
approved these changes
Mar 13, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 prevents the
connectfunction from being called beforeWalletConnectionProps.activeConnectoris ready as the call would then fail. The expectation is that the button/function invokingconnectchecks that doing so is valid. With this change that check is now more direct and less error-prone.This a only barely a breaking change because the expected usage of passing the function to
onClickof a button keeps working without modification. The difference is that now the click is a noop if the call is invaild instead of an exception being thrown. And checking validity is just the truthiness value ofconnect. In other words you can now just doNice and simple.
An alternative solution would be to return an additional boolean
isReadyToConnect, but that would not allow the type system to prevent the call like it does with this one.