Skip to content

doc: document url.format(urlString) as deprecated under DEP0169 #61644

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

doc: document url.format(urlString) as deprecated under DEP0169 #61644

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3758,6 +3758,9 @@ Type: Application (non-`node_modules` code only)
have security implications. Use the [WHATWG URL API][] instead. CVEs are not
issued for `url.parse()` vulnerabilities.

Passing a string argument to [`url.format()`][] invokes `url.parse()`
internally, and is therefore also covered by this deprecation.
Copy link
Member

@JakobJingleheimer JakobJingleheimer Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: I think covered sounds a little weird here

Suggested change
internally, and is therefore also covered by this deprecation.
internally, and is therefore also effected by this deprecation.


### DEP0170: Invalid port when using `url.parse()`

<!-- YAML
Expand Down
47 changes: 44 additions & 3 deletions doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1739,9 +1739,8 @@
times.
-->

* `urlObject` {Object|string} A URL object (as returned by `url.parse()` or
constructed otherwise). If a string, it is converted to an object by passing
it to `url.parse()`.
* `urlObject` {Object} A URL object (as returned by `url.parse()` or
constructed otherwise).
Copy link
Member

@JakobJingleheimer JakobJingleheimer Feb 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: maybe just me, I think this sounds a little smoother, less yoda-ish

Suggested change
constructed otherwise).
otherwise constructed).


The `url.format()` method returns a formatted URL string derived from
`urlObject`.
Expand Down Expand Up @@ -1822,6 +1821,48 @@
npx codemod@latest @nodejs/node-url-to-whatwg-url
```

### `url.format(urlString)`

<!-- YAML
added: v0.1.25
changes:
- version:
- v24.0.0
pr-url: https://github.com/nodejs/node/pull/55017

Check warning on line 1831 in doc/api/url.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: Application deprecation.
-->

> Stability: 0 - Deprecated: Use the WHATWG URL API instead.

* `urlString` {string} A string that will be passed to `url.parse()` and then
formatted.

`url.format(urlString)` is shorthand for `url.format(url.parse(urlString))`.

Because it invokes the deprecated [`url.parse()`][], passing a string argument
to `url.format()` is itself deprecated.

Canonicalizing a URL string can be performed using the WHATWG URL API, by
constructing a new URL object and calling [`url.toString()`][].

```mjs
import { URL } from 'node:url';

const unformatted = 'http://[fe80:0:0:0:0:0:0:1]:/a/b?a=b#abc';
const formatted = new URL(unformatted).toString();

console.log(formatted); // Prints: http://[fe80::1]/a/b?a=b#abc
```

```cjs
const { URL } = require('node:url');

const unformatted = 'http://[fe80:0:0:0:0:0:0:1]:/a/b?a=b#abc';
const formatted = new URL(unformatted).toString();

console.log(formatted); // Prints: http://[fe80::1]/a/b?a=b#abc
```

### `url.parse(urlString[, parseQueryString[, slashesDenoteHost]])`

<!-- YAML
Expand Down
Loading