doc: document url.format(urlString) as deprecated under DEP0169
#61644
+47
−3
Conversation
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
Collaborator
|
Review requested:
|
Renegade334
added
doc
JakobJingleheimer
approved these changes
Feb 2, 2026
| issued for `url.parse()` vulnerabilities. | ||
|
|
||
| Passing a string argument to [`url.format()`][] invokes `url.parse()` | ||
| internally, and is therefore also covered by this deprecation. |
Member
There was a problem hiding this comment.
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. |
| 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). |
Member
There was a problem hiding this comment.
nit: maybe just me, I think this sounds a little smoother, less yoda-ish
Suggested change
| constructed otherwise). | |
| otherwise constructed). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Because
url.format("...")passes its argument viaurl.parse()before formatting it, this usage is covered under the application-runtime deprecation behaviour of DEP0169. This was not previously documented.Separating out the documentation for
url.format(urlString)fromurl.format(urlObject)seems like the cleanest approach. The latter signature remains legacy.