Skip to content

docs(dispatcher): use RFC 2606 domains in interceptor examples #4873

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

Merged
mcollina merged 1 commit into from
Mar 8, 2026
Merged

docs(dispatcher): use RFC 2606 domains in interceptor examples #4873

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
16 changes: 8 additions & 8 deletions docs/docs/api/Dispatcher.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -962,7 +962,7 @@ It accepts the same arguments as the [`RedirectHandler` constructor](/docs/docs/
const { Client, interceptors } = require("undici");
const { redirect } = interceptors;

const client = new Client("http://example.com").compose(
const client = new Client("http://service.example").compose(
redirect({ maxRedirections: 3, throwOnMaxRedirects: true })
);
client.request({ path: "/" })
Expand All @@ -980,7 +980,7 @@ It accepts the same arguments as the [`RetryHandler` constructor](/docs/docs/api
const { Client, interceptors } = require("undici");
const { retry } = interceptors;

const client = new Client("http://example.com").compose(
const client = new Client("http://service.example").compose(
retry({
maxRetries: 3,
minTimeout: 1000,
Expand All @@ -1006,7 +1006,7 @@ The `dump` interceptor enables you to dump the response body from a request upon
const { Client, interceptors } = require("undici");
const { dump } = interceptors;

const client = new Client("http://example.com").compose(
const client = new Client("http://service.example").compose(
dump({
maxSize: 1024,
})
Expand Down Expand Up @@ -1132,7 +1132,7 @@ The `responseError` interceptor throws an error for responses with status code e
const { Client, interceptors } = require("undici");
const { responseError } = interceptors;

const client = new Client("http://example.com").compose(
const client = new Client("http://service.example").compose(
responseError()
);

Expand Down Expand Up @@ -1160,7 +1160,7 @@ The `decompress` interceptor automatically decompresses response bodies that are
const { Client, interceptors } = require("undici");
const { decompress } = interceptors;

const client = new Client("http://example.com").compose(
const client = new Client("http://service.example").compose(
decompress()
);

Expand All @@ -1177,7 +1177,7 @@ const response = await client.request({
const { Client, interceptors } = require("undici");
const { decompress } = interceptors;

const client = new Client("http://example.com").compose(
const client = new Client("http://service.example").compose(
decompress({
skipErrorResponses: false, // Decompress 5xx responses
skipStatusCodes: [204, 304, 201] // Skip these status codes
Expand Down Expand Up @@ -1231,12 +1231,12 @@ const { Client, interceptors } = require("undici");
const { deduplicate, cache } = interceptors;

// Deduplicate only
const client = new Client("http://example.com").compose(
const client = new Client("http://service.example").compose(
deduplicate()
);

// Deduplicate with caching
const clientWithCache = new Client("http://example.com").compose(
const clientWithCache = new Client("http://service.example").compose(
deduplicate(),
cache()
);
Expand Down
Loading