Skip to content

doc: document differences between Node.js fetch() and the standard #63714

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.

Sign up for GitHub

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
Parvez9677 wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −0
Open

doc: document differences between Node.js fetch() and the standard #63714

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions doc/api/globals.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -567,6 +567,20 @@ The implementation is based upon [undici](https://undici.nodejs.org), an HTTP/1.
written from scratch for Node.js. You can figure out which version of `undici` is bundled
in your Node.js process reading the `process.versions.undici` property.

### Differences from browser `fetch()`

While Node.js's `fetch()` aims to be compatible with the
[Fetch Standard][], there are some notable differences:

* Node.js accepts [`AsyncIterable`][] as `Request` and `Response`
body inputs. The Fetch Standard only supports `ReadableStream`.
* Cookies are not stored or sent automatically. The Fetch Standard
requires implementations to support a cookie store, which
Node.js does not provide.
* Node.js does not enforce [forbidden header names][]. Browsers
prevent user code from setting certain headers such as `Host`
and `Content-Length`; Node.js allows them to be set freely.

### Custom dispatcher

You can use a custom dispatcher to dispatch requests passing it in fetch's options object.
Expand Down Expand Up @@ -1409,6 +1423,8 @@ A browser-compatible implementation of [`WritableStreamDefaultWriter`][].
[`clearTimeout`]: timers.md#cleartimeouttimeout
[`console`]: console.md
[`exports`]: modules.md#exports
[Fetch Standard]: https://fetch.spec.whatwg.org/
[forbidden header names]: https://fetch.spec.whatwg.org/#forbidden-header-name
[`fetch()`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/fetch
[`globalThis`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/globalThis
[`localStorage`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage
Expand All @@ -1424,6 +1440,7 @@ A browser-compatible implementation of [`WritableStreamDefaultWriter`][].
[`structuredClone`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/structuredClone
[`window.navigator`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/navigator
[`worker_threads.locks`]: worker_threads.md#worker_threadslocks
[AsyncIterable]: https://tc39.es/ecma262/#sec-asynciterable-interface
[browser `LockManager`]: https://developer.mozilla.org/en-US/docs/Web/API/LockManager
[buffer section]: buffer.md
[built-in objects]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects
Expand Down
Loading