search

holepunchto / hyperswarm

A distributed networking stack for connecting peers.
https://docs.holepunch.to
MIT License
1.04k stars 84 forks source link

Add typings for Hyperswarm #56

Closed JonasKruckenberg closed 2 years ago

JonasKruckenberg commented 4 years ago

Here we go. This aims to resolve #55. Basic Types for all the classes. A few descriptions are still missing, but maybe we get that sorted out, I also marked all the methods starting with an underscore as private, not sure if that's right or not. Maybe you can also complete some of the method and property descriptions since you know much better what they're supposed to do. Maybe don't merge this yet though, we should wait with this until all the Hyperswarm dependencies have typings right?

JonasKruckenberg commented 4 years ago

It’s for the type definitions of classes taken from nodejs like EventEmitter and Socket, as they’re not defined otherwise. Keeping them compatible with all LTS versions and versions going forward should not be that big of a deal since both interfaces are stable and did not change since version 8 ( as far as i can tell ) so no problem there.

mafintosh commented 2 years ago

Closing for now as we did tons of updates! @kasperisager maybe this could act as a foundation for our typings?