Skip to content

doc: url.format() parameter may be a string #7235

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

Closed
Trott wants to merge 1 commit into from
Closed

doc: url.format() parameter may be a string #7235

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
15 changes: 10 additions & 5 deletions doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,13 +135,17 @@ For example: `'#hash'`
added: v0.1.25
-->

* `urlObject` {Object} A URL object (either as returned by `url.parse()` or
constructed otherwise).
* `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()`.

The `url.format()` method processes the given URL object and returns a formatted
URL string.
The `url.format()` method returns a formatted URL string derived from
`urlObject`.

The formatting process essentially operates as follows:
If `urlObject` is not an object or a string, `url.parse()` will throw a
[`TypeError`][].

The formatting process operates as follows:

* A new empty string `result` is created.
* If `urlObject.protocol` is a string, it is appended as-is to `result`.
Expand Down Expand Up @@ -247,3 +251,4 @@ forward slash (`/`) character is encoded as `%3C`.

[`Error`]: errors.html#errors_class_error
[`querystring`]: querystring.html
[`TypeError`]: errors.html#errors_class_typeerror