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
doc: note readable/writeable .toWeb()/.fromWeb() exist in webstreams docs #45381
Comments
Even better, could this transformation be done automatically? There’s really only one reasonable thing to do when passing a WriteStream to something that expects a WritableStream. |
We have some docs in https://nodejs.org/api/stream.html#streamwritabletowebstreamwritable |
@MrJithil yes, that's the problem. It's only documented in one place, which is notably not the place you'd be looking for context on WebStreams. |
going to add the
good first issue
|
Hey, @bnb, I Just wanted to ask where the details about |
@7suyash7 I'd probably either just at the top under the overview section or as you noted in each of those sections. Either is a valid approach IMO, though PR reviewers might disagree with me. I would recommend just having whatever is implemented as a note that links to the actual API docs for those methods, rather than having code examples. However if you also want to improve those API docs, that's of course welcome as well 😊 |
@bnb PTAL. Thanks! |
…in webstreams docs fixed
Affected URL(s)
https://nodejs.org/api/webstreams.html
Description of the problem
currently, there's no indication on the webstreams docs that
.toWeb()
and.fromWeb()
exist. Noting that they exist somewhere on the webstreams docs would probably be a good idea. I just watched two very capable engineers spend longer than they should have figure out that these features existed while trying to usefetch
and streams because they weren't in the webstreams docs - if they're tripping over this, I very much imagine it will be something that comes up again for others.The text was updated successfully, but these errors were encountered: