-
Notifications
You must be signed in to change notification settings - Fork 446
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Awesome Endeavour: Async Iterators #266
Comments
I've updated the original issue post to include our approach for iterating on the internal refactor of js-libp2p. |
@jacobheun @vasco-santos one thing I couldn't find notes of but I believe to be the case. The js-libp2p top level API should be updated to remove callbacks and pull streams and only expose the async iterators interface. Is there a card for this? |
Hey! Yes, that is part of the work for |
@libp2p/javascript-team see thread at Awesome Endeavour: Async Iterators
Migration Notice: As libp2p modules migrate to async/await there will be some level of incompatibility when trying to include the latest release of modules. You can see the latest support minor versions of each module below.
JS Libp2p Refactor
As more of the dependencies for libp2p are finishing their migrations, we are starting on the internals of js-libp2p. Due to the fact that there are a LOT of things that need to be updated internally, we will be cutting the work into smaller, isolated chunks. This will allow us to iterate, avoiding a much larger PR.
Working Branch
All async PRs to js-libp2p internals that break compatibility should be opened against the refactor/async-await branch.
Submitting a PR
If there is a subsystem that you wish to take on, please add a comment to the internals refactor Trello card, or open a DRAFT PR, so that others know it's being worked on.
Async Iterators Guidance
JS Libp2p is migrating to iterable streams from pull-streams. If you are not familiar with iterable streams you can see an overview of their various forms here. They are used in much the same way that pull-streams are, except they can be iterated on.
For a more in depth, evolving guide on how to use iterable streams, check out the iterables readme. If you have a use case that is not yet in the guide that other would benefit from, please submit a PR!
The text was updated successfully, but these errors were encountered: