docs: add stream wrapping example #466
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
docs: add iterable types from @alanshaw's gist
This was referenced Oct 20, 2019
vasco-santos
suggested changes
Oct 20, 2019
Co-Authored-By: Vasco Santos <vasco.santos@moxy.studio>
alanshaw
suggested changes
Oct 21, 2019
doc/STREAMING_ITERABLES.md
Outdated
|
|
||
| // Wrapper is what we will write and read from | ||
| // This gives us two duplex iterables that are internally connected | ||
| const wrapper = duplexPair() |
There was a problem hiding this comment.
You might want to name these pairs to make it easier to understand in the example.
For example:
Suggested change
| const wrapper = duplexPair() | |
| const [client, server] = duplexPair() |
There was a problem hiding this comment.
I went with internal and external. I don't feel great about these names, but the pairing is used to have 1 half integrate with the external duplex connection and the other half is what we would use internally to read/write data to.
doc/STREAMING_ITERABLES.md
Outdated
| async (source) => { | ||
| for await (const chunk of source) { | ||
| // Chunk will be a BufferList, we can slice it to get the underlying buffer | ||
| console.log('Data: %s', chunk.slice()) |
There was a problem hiding this comment.
You could just call toString(). In the example there's nothing to say what existingDuplex is yielding so personally I wouldn't complicate it (then you can remove the comment).
https://github.com/rvagg/bl#toString
Suggested change
| console.log('Data: %s', chunk.slice()) | |
| console.log('Data: %s', chunk.toString()) |
doc/STREAMING_ITERABLES.md
Outdated
| - [Iterable Modules](#iterable-modules) | ||
|
|
||
| ## Usage Guide | ||
|
|
||
| **Coming Soon!** | ||
| ### Wrapping Duplex Iterables |
There was a problem hiding this comment.
I'd express this in terms of what it enables you to do. Typically people know what they want to do but don't know how to do it.
vasco-santos
approved these changes
Oct 21, 2019
alanshaw
approved these changes
Oct 21, 2019
dirkmc
pushed a commit
that referenced
this pull request
Nov 26, 2019
* docs: add duplex wrapping example docs: add iterable types from @alanshaw's gist * docs(fix): add feedback fix Co-Authored-By: Vasco Santos <vasco.santos@moxy.studio> * docs: clean up based on feedback
dirkmc
pushed a commit
that referenced
this pull request
Nov 26, 2019
* docs: add duplex wrapping example docs: add iterable types from @alanshaw's gist * docs(fix): add feedback fix Co-Authored-By: Vasco Santos <vasco.santos@moxy.studio> * docs: clean up based on feedback
jacobheun
added a commit
that referenced
this pull request
Dec 12, 2019
* docs: add duplex wrapping example docs: add iterable types from @alanshaw's gist * docs(fix): add feedback fix Co-Authored-By: Vasco Santos <vasco.santos@moxy.studio> * docs: clean up based on feedback
jacobheun
added a commit
that referenced
this pull request
Jan 24, 2020
* docs: add duplex wrapping example docs: add iterable types from @alanshaw's gist * docs(fix): add feedback fix Co-Authored-By: Vasco Santos <vasco.santos@moxy.studio> * docs: clean up based on feedback
maschad
pushed a commit
to maschad/js-libp2p
that referenced
this pull request
Jun 21, 2023
) Bumps [@libp2p/interface-libp2p](https://github.com/libp2p/js-libp2p-interfaces) from 2.0.0 to 3.0.0. - [Release notes](https://github.com/libp2p/js-libp2p-interfaces/releases) - [Commits](https://github.com/libp2p/js-libp2p-interfaces/compare/@libp2p/interface-libp2p-v2.0.0...@libp2p/interface-libp2p-v3.0.0) --- updated-dependencies: - dependency-name: "@libp2p/interface-libp2p" dependency-type: direct:development update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alex Potsides <alex@achingbrain.net>
maschad
pushed a commit
to maschad/js-libp2p
that referenced
this pull request
Jun 21, 2023
## [9.1.3](libp2p/js-libp2p-kad-dht@v9.1.2...v9.1.3) (2023-05-04) ### Dependencies * **dev:** bump @libp2p/interface-libp2p from 2.0.0 to 3.0.0 ([libp2p#466](libp2p/js-libp2p-kad-dht#466)) ([d8f8e5a](libp2p/js-libp2p-kad-dht@d8f8e5a))
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.
docs: add iterable types from alanshaw's gist
This adds a new, and the first, example for streaming iterables. I was working on the crypto interface and needed to do this, so sharing it here.
I also pulled over snippets of the iterables types from @alanshaw's gist to avoid being reliant on that always existing, but I made sure to link to it to credit his work.