Node.js includes a built-in fetch() implementation powered by undici starting from Node.js v18. However, there are important differences between using the built-in fetch and installing undici as a separate module.
Built-in Fetch (Node.js v18+)
Node.js's built-in fetch is powered by a bundled version of undici:
// Available globally in Node.js v18+const response = await fetch('https://api.example.com/data');const data = await response.json();// Check the bundled undici versionconsole.log(process.versions.undici); // e.g., "5.28.4"
Limited to the undici version bundled with your Node.js version
Less control over connection pooling and advanced features
Error handling follows Web API standards (errors wrapped in TypeError)
Performance overhead due to Web Streams implementation
Undici Module
Installing undici as a separate module gives you access to the latest features and APIs:
npm install undici
import { request, fetch, Agent, setGlobalDispatcher } from 'undici';// Use undici.request for maximum performanceconst { statusCode, headers, body } = await request('https://api.example.com/data');const data = await body.json();// Or use undici.fetch with custom configurationconst agent = new Agent({ keepAliveTimeout: 10000 });setGlobalDispatcher(agent);const response = await fetch('https://api.example.com/data');
Pros:
Latest undici features and bug fixes
Access to advanced APIs (request, stream, pipeline)
Fine-grained control over connection pooling
Better error handling with clearer error messages
Superior performance, especially with undici.request
HTTP/1.1 pipelining support
Custom interceptors and middleware
Advanced features like ProxyAgent, Socks5Agent, MockAgent
Cons:
Additional dependency to manage
Larger bundle size
When to Use Each
Use Built-in Fetch When:
You want zero dependencies
Building isomorphic code that runs in browsers and Node.js
Publishing to npm and want to maximize compatibility with JS runtimes
Simple HTTP requests without advanced configuration
You're publishing to npm and you want to maximize compatiblity
You don't depend on features from a specific version of undici
Use Undici Module When:
You need the latest undici features and performance improvements
You require advanced connection pooling configuration
You need APIs not available in the built-in fetch (ProxyAgent, Socks5Agent, MockAgent, etc.)
Performance is critical (use undici.request for maximum speed)
You want better error handling and debugging capabilities
You need HTTP/1.1 pipelining or advanced interceptors
You prefer decoupled protocol and API interfaces
Performance Comparison
Based on benchmarks, here's the typical performance hierarchy:
undici.request() - Fastest, most efficient
undici.fetch() - Good performance, standard compliance
Node.js http/https - Baseline performance
Migration Guide
If you're currently using built-in fetch and want to migrate to undici:
When you send a FormData body, keep fetch and FormData from the same
implementation.
Use one of these patterns:
// Built-in globalsconst body = new FormData()body.set('name', 'some')await fetch('https://example.com', { method: 'POST', body})
// undici module importsimport { fetch, FormData } from 'undici'const body = new FormData()body.set('name', 'some')await fetch('https://example.com', { method: 'POST', body})
If you want the installed undici package to provide the globals, call
install() first:
import { install } from 'undici'install()const body = new FormData()body.set('name', 'some')await fetch('https://example.com', { method: 'POST', body})
install() replaces the global fetch, Headers, Response, Request, and
FormData implementations with undici's versions, so they all match.
Avoid mixing a global FormData with undici.fetch(), or undici.FormData
with the built-in global fetch().
Version Compatibility
You can check which version of undici is bundled with your Node.js version:
console.log(process.versions.undici);
Installing undici as a module allows you to use a newer version than what's bundled with Node.js, giving you access to the latest features and performance improvements.
Quick Start
Basic Request
import { request } from 'undici'const { statusCode, headers, trailers, body} = await request('http://localhost:3000/foo')console.log('response received', statusCode)console.log('headers', headers)for await (const data of body) { console.log('data', data) }console.log('trailers', trailers)
Using Cache Interceptor
Undici provides a powerful HTTP caching interceptor that follows HTTP caching best practices. Here's how to use it:
import { fetch, Agent, interceptors, cacheStores } from 'undici';// Create a client with cache interceptorconst client = new Agent().compose(interceptors.cache({ // Optional: Configure cache store (defaults to MemoryCacheStore) store: new cacheStores.MemoryCacheStore({ maxSize: 100 * 1024 * 1024, // 100MB maxCount: 1000, maxEntrySize: 5 * 1024 * 1024 // 5MB }), // Optional: Specify which HTTP methods to cache (default: ['GET', 'HEAD']) methods: ['GET', 'HEAD']}));// Set the global dispatcher to use our caching clientsetGlobalDispatcher(client);// Now all fetch requests will use the cacheasync function getData() { const response = await fetch('https://api.example.com/data'); // The server should set appropriate Cache-Control headers in the response // which the cache will respect based on the cache policy return response.json();}// First request - fetches from originconst data1 = await getData();// Second request - served from cache if within max-ageconst data2 = await getData();
Key Features:
Automatic Caching: Respects Cache-Control and Expires headers
Validation: Supports ETag and Last-Modified validation
Storage Options: In-memory or persistent SQLite storage
Flexible: Configure cache size, TTL, and more
Global Installation
Undici provides an install() function to add all WHATWG fetch classes to globalThis, making them available globally:
import { install } from 'undici'// Install all WHATWG fetch classes globallyinstall()// Now you can use fetch classes globally without importingconst response = await fetch('https://api.example.com/data')const data = await response.json()// All classes are available globally:const headers = new Headers([['content-type', 'application/json']])const request = new Request('https://example.com')const formData = new FormData()const ws = new WebSocket('wss://example.com')const eventSource = new EventSource('https://example.com/events')
The install() function adds the following classes to globalThis:
When you call install(), these globals come from the same undici
implementation. For example, global fetch and global FormData will both be
undici's versions, which is the recommended setup if you want to use undici
through globals.
This is useful for:
Polyfilling environments that don't have fetch
Ensuring consistent fetch behavior across different Node.js versions
Making undici's implementations available globally for libraries that expect them
Body Mixins
The body mixins are the most common way to format the request/response body. Mixins include:
Note: Once a mixin has been called then the body cannot be reused, thus calling additional mixins on .body, e.g. .body.json(); .body.text() will result in an error TypeError: unusable being thrown and returned through the Promise rejection.
Should you need to access the body in plain-text after using a mixin, the best practice is to use the .text() mixin first and then manually parse the text to the desired format.
For more information about their behavior, please reference the body mixin from the Fetch Standard.
Common API Methods
This section documents our most commonly used API methods. Additional APIs are documented in their own files within the docs folder and are accessible via the navigation list on the left side of the docs site.
FormData besides text data and buffers can also utilize streams via Blob objects:
import { openAsBlob } from 'node:fs'const file = await openAsBlob('./big.csv')const body = new FormData()body.set('file', file, 'big.csv')await fetch('http://example.com', { method: 'POST', body })
request.duplex
'half'
In this implementation of fetch, request.duplex must be set if request.body is ReadableStream or Async Iterables, however, even though the value must be set to 'half', it is actually a full duplex. For more detail refer to the Fetch Standard.
response.body
Nodejs has two kinds of streams: web streams, which follow the API of the WHATWG web standard found in browsers, and an older Node-specific streams API. 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().
This section documents parts of the HTTP/1.1 and Fetch Standard that Undici does
not support or does not fully implement.
CORS
Unlike browsers, Undici does not implement CORS (Cross-Origin Resource Sharing) checks by default. This means:
No preflight requests are automatically sent for cross-origin requests
No validation of Access-Control-Allow-Origin headers is performed
Requests to any origin are allowed regardless of the source
This behavior is intentional for server-side environments where CORS restrictions are typically unnecessary. If your application requires CORS-like protections, you will need to implement these checks manually.
The Fetch Standard allows users to skip consuming the response body by relying on
garbage collection to release connection resources.
Garbage collection in Node is less aggressive and deterministic
(due to the lack of clear idle periods that browsers have through the rendering refresh rate)
which means that leaving the release of connection resources to the garbage collector can lead
to excessive connection usage, reduced performance (due to less connection re-use), and even
stalls or deadlocks when running out of connections.
Therefore, it is important to always either consume or cancel the response body anyway.
// Doconst { body, headers } = await fetch(url);for await (const chunk of body) { // force consumption of body}// Do notconst { headers } = await fetch(url);
However, if you want to get only headers, it might be better to use HEAD request method. Usage of this method will obviate the need for consumption or cancelling of the response body. See MDN - HTTP - HTTP request methods - HEAD for more details.
The Fetch Standard requires implementations to exclude certain headers from requests and responses. In browser environments, some headers are forbidden so the user agent remains in full control over them. In Undici, these constraints are removed to give more control to the user.
Undici limits the number of Content-Encoding layers in a response to 5 to prevent resource exhaustion attacks. If a server responds with more than 5 content-encodings (e.g., Content-Encoding: gzip, gzip, gzip, gzip, gzip, gzip), the fetch will be rejected with an error. This limit matches the approach taken by curl and urllib3.
Sets the global dispatcher used by Common API Methods. Global dispatcher is shared among compatible undici modules,
including undici that is bundled internally with node.js.
undici.getGlobalDispatcher()
Gets the global dispatcher used by Common API Methods.
Returns: Dispatcher
undici.setGlobalOrigin(origin)
origin string | URL | undefined
Sets the global origin used in fetch.
If undefined is passed, the global origin will be reset. This will cause Response.redirect, new Request(), and fetch to throw an error when a relative path is passed.
Undici will only use pipelining if configured with a pipelining factor
greater than 1. Also it is important to pass blocking: false to the
request options to properly pipeline requests.
Undici always assumes that connections are persistent and will immediately
pipeline requests, without checking whether the connection is persistent.
Hence, automatic fallback to HTTP/1.0 or HTTP/1.1 without pipelining is
not supported.
Undici will immediately pipeline when retrying requests after a failed
connection. However, Undici will not retry the first remaining requests in
the prior pipeline and instead error the corresponding callback/promise/stream.
Undici will abort all running requests in the pipeline when any of them are
aborted.
Since it is not possible to manually follow an HTTP redirect on the server-side,
Undici returns the actual response instead of an opaqueredirect filtered one
when invoked with a manual redirect. This aligns fetch() with the other
implementations in Deno and Cloudflare Workers.
If you experience problem when connecting to a remote server that is resolved by your DNS servers to a IPv6 (AAAA record)
first, there are chances that your local router or ISP might have problem connecting to IPv6 networks. In that case
undici will throw an error with code UND_ERR_CONNECT_TIMEOUT.
If the target server resolves to both a IPv6 and IPv4 (A records) address and you are using a compatible Node version
(18.3.0 and above), you can fix the problem by providing the autoSelectFamily option (support by both undici.request
and undici.Agent) which will enable the family autoselection algorithm when establishing the connection.