From c15a4f8130dd09eff87a9e0f95501dba17024804 Mon Sep 17 00:00:00 2001 From: bmuenzenmeyer Date: Tue, 28 Jul 2026 08:21:21 -0500 Subject: [PATCH 1/3] doc: report proper return type on url.format Signed-off-by: Brian Muenzenmeyer --- doc/api/url.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/url.md b/doc/api/url.md index d5dc06055b6cc3..7160e2f2e66ef1 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -1742,6 +1742,8 @@ changes: * `urlObject` {Object} A URL object (as returned by `url.parse()` or constructed otherwise). +* Returns: {string} + The `url.format()` method returns a formatted URL string derived from `urlObject`. From 505add9a2531bc083170215063fa0bc328d36bd9 Mon Sep 17 00:00:00 2001 From: bmuenzenmeyer Date: Tue, 28 Jul 2026 09:17:52 -0500 Subject: [PATCH 2/3] add return type to override --- doc/api/url.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/api/url.md b/doc/api/url.md index 7160e2f2e66ef1..762efe26c73eb0 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -1839,6 +1839,8 @@ changes: * `urlString` {string} A string that will be passed to `url.parse()` and then formatted. +* Returns: {string} + `url.format(urlString)` is shorthand for `url.format(url.parse(urlString))`. Because it invokes the deprecated [`url.parse()`][] internally, passing a string argument From a1fc9800362f33379e5d904b75649fde5241f347 Mon Sep 17 00:00:00 2001 From: Brian Muenzenmeyer Date: Tue, 28 Jul 2026 20:42:43 -0500 Subject: [PATCH 3/3] chore: remove whitespace Co-authored-by: Aviv Keller --- doc/api/url.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/api/url.md b/doc/api/url.md index 762efe26c73eb0..bdc27144fa3a12 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -1741,7 +1741,6 @@ changes: * `urlObject` {Object} A URL object (as returned by `url.parse()` or constructed otherwise). - * Returns: {string} The `url.format()` method returns a formatted URL string derived from @@ -1838,7 +1837,6 @@ changes: * `urlString` {string} A string that will be passed to `url.parse()` and then formatted. - * Returns: {string} `url.format(urlString)` is shorthand for `url.format(url.parse(urlString))`.