docs: add Getting Started guide#5371
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5371 +/- ##
=======================================
Coverage 93.25% 93.25%
=======================================
Files 110 110
Lines 36738 36738
=======================================
+ Hits 34259 34260 +1
+ Misses 2479 2478 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
mcollina
reviewed
Jun 7, 2026
| import { createWriteStream } from 'node:fs' | ||
|
|
||
| const res = await fetch('https://example.com/large-file.zip') | ||
| Readable.fromWeb(res.body).pipe(createWriteStream('./file.zip')) |
Member
There was a problem hiding this comment.
This has a few problems. The actual solution is to use pipeline from node:stream with res.body and createWriteStream.
| | `fetch` | Quick requests, standard API compatibility, JSON/form bodies | | ||
| | `request` | Maximum throughput, reading response headers, fine-grained control | | ||
| | `stream` | Piping responses directly to a writable stream | | ||
| | `pipeline` | Streaming request bodies combined with streaming responses | |
Member
There was a problem hiding this comment.
I would not document this here, and ideally not even stream.
… streaming, remove stream/pipeline docs
Contributor
Author
|
pushed -- added a Request object example, switched the streaming snippet to use |
This was referenced Jun 8, 2026
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
addresses #2208
adds a Getting Started guide covering the most common undici use cases:
fetchfor simple requestsrequest/stream/pipelinefor more control