docs: add basic example of fetch #1035
Merged
Conversation
This file contains hidden or 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
mcollina
reviewed
Sep 15, 2021
fix code formatting Co-authored-by: Matteo Collina <[email protected]>
fix code indentation Co-authored-by: Matteo Collina <[email protected]>
Codecov Report
@@ Coverage Diff @@
## main #1035 +/- ##
=======================================
Coverage 94.89% 94.89%
=======================================
Files 37 37
Lines 3623 3623
=======================================
Hits 3438 3438
Misses 185 185 Continue to review full report at Codecov.
|
ronag
reviewed
Sep 15, 2021
mcollina
reviewed
Sep 20, 2021
README.md
Outdated
| } | ||
| ``` | ||
|
|
||
| If you require a Node stream, it is possible to convert between the two using `.fromWeb()`. |
There was a problem hiding this comment.
it's actually .fromWeb() and .toWeb() if you are referring to converting between the two, since that implies both ways. Otherwise please formulate it in a way where it's explicit one way.
ronag
approved these changes
Sep 20, 2021
README.md
Outdated
|
|
||
| Basic usage example: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Please, add js after triple ` when you open code blocks to enable syntax highlighting in examples. This will improve readability.
README.md
Outdated
|
|
||
| Nodejs has two kinds of streams: [web streams](https://nodejs.org/dist/latest-v16.x/docs/api/webstreams.html) which follow the API of the WHATWG web standard found in browsers, and an older Node-specific [streams API](https://nodejs.org/api/stream.html). `response.body` returns a readable web stream. If you would prefer to work with a Node stream you can convert a web stream using `.fromWeb()`. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Same for this example - add js, please.
Add syntax highlighting to codeblock
KhafraDev
pushed a commit
to KhafraDev/undici
that referenced
this pull request
Jun 23, 2022
* docs: add basic usage example of fetch * remove promise example * Update README.md fix code formatting Co-authored-by: Matteo Collina <[email protected]> * Update README.md fix code indentation Co-authored-by: Matteo Collina <[email protected]> * make fromWeb clearer * improve language about fromWeb * Update README.md Add syntax highlighting to codeblock Co-authored-by: Matteo Collina <[email protected]>
crysmags
pushed a commit
to crysmags/undici
that referenced
this pull request
Feb 27, 2024
* docs: add basic usage example of fetch * remove promise example * Update README.md fix code formatting Co-authored-by: Matteo Collina <[email protected]> * Update README.md fix code indentation Co-authored-by: Matteo Collina <[email protected]> * make fromWeb clearer * improve language about fromWeb * Update README.md Add syntax highlighting to codeblock Co-authored-by: Matteo Collina <[email protected]>
5 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Adding a simple usage example of Fetch and a very brief explanation of Node Streams vs Web Streams.
#940