chore: improve types for Hypercore peers #735
Merged
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
*This is a types-only change.* Before this change, we used `any` for a Hypercore peer's type. After this change, we use a new type, `HypercorePeer`, designed to match [Hypercore's `Peer` class][0]. Ideally, we would put this in `@digidem/types` or DefinitelyTyped. For now, I think this is an improvement over the `any`s we currently use. I did this because I'm working with peer-related code and found the `any`s difficult to work with. [0]: https://github.com/holepunchto/hypercore/blob/de993dc051301f03570df0eb7929c06286745563/lib/replicator.js#L331
|
Just something to consider: seems like that class has changed a bit between the version of hypercore we use and the commit you link to (which is latest commit on their main branch at time of writing). |
|
Good point. These types are for the version of Hypercore we use, not the version linked.
|
tomasciccola
approved these changes
Aug 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 is a types-only change.
Before this change, we used
anyfor a Hypercore peer's type.After this change, we use a new type,
HypercorePeer, designed to match Hypercore'sPeerclass.Ideally, we would put this in
@digidem/typesor DefinitelyTyped. For now, I think this is an improvement over theanys we currently use.I did this because I'm working with peer-related code and found the
anys difficult to work with.