-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
doc: add differences between Node.js fetch and standard Fetch API #56314
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
Open
asrar211
wants to merge
3
commits into
nodejs:main
Choose a base branch
from
asrar211:doc-fetch-differences
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -531,6 +531,26 @@ changes: | |
|
||
A browser-compatible implementation of the [`fetch()`][] function. | ||
|
||
### Differences Between Node.js `fetch()` and Standard Fetch API | ||
|
||
Node.js's `fetch()` implementation is inspired by the Fetch API standard, but it includes several key differences: | ||
|
||
1. **`new Response(asyncIterable)`**: | ||
* Node.js extends the standard `Response` constructor to accept an `asyncIterable` as its body. This allows streams and other async sources to be directly used. This feature is not part of the Fetch API in browsers. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit: line wrapping in this file to match the rest please |
||
|
||
2. **Cookies Handling**: | ||
* Unlike browsers, Node.js does not automatically manage cookies. In browsers, cookies are managed through the `Cookie` header and automatically sent with requests. In Node.js, you need to manually handle cookies, potentially using additional libraries like `node-fetch-cookie`. | ||
|
||
3. **No Forbidden Headers**: | ||
* In browsers, there are several headers (e.g., `User-Agent`, `Referer`, `Host`) that are restricted from being modified by the developer for security reasons. In Node.js, these headers can be freely set, giving developers more control. | ||
|
||
4. **Environment-Specific Behavior**: | ||
* Node.js operates outside of a browser environment and doesn't have access to browser-specific features like Service Workers, Cache API, etc. This can affect how requests and responses are handled in Node.js. | ||
|
||
For more details, refer to the [WHATWG Fetch Standard](https://fetch.spec.whatwg.org/) and the Node.js implementation notes. | ||
|
||
The `fetch()` function in Node.js is based on the Fetch API standard but has several differences. For a detailed comparison of how Node.js’s `fetch` differs from the standard Fetch API, see the [Undici documentation](https://github.com/nodejs/undici/blob/main/docs/fetch-differences.md). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That link no longer works |
||
|
||
## Class: `File` | ||
|
||
<!-- YAML | ||
|
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.