Skip to content
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

doc: add deprecated badge to legacy URL methods #34931

Closed
wants to merge 1 commit into from
Closed

doc: add deprecated badge to legacy URL methods #34931

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
13 changes: 11 additions & 2 deletions doc/api/url.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1024,8 +1024,9 @@ pathToFileURL('/some/path%.c'); // Correct: file:///some/path%25.c (POSIX)
```

## Legacy URL API

> Stability: 0 - Deprecated: Use the WHATWG URL API instead.
<!-- YAML
deprecated: v11.0.0
-->

### Legacy `urlObject`
<!-- YAML
Expand All @@ -1035,6 +1036,8 @@ changes:
description: The Legacy URL API is deprecated. Use the WHATWG URL API.
-->

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

The legacy `urlObject` (`require('url').Url`) is created and returned by the
`url.parse()` function.

Expand Down Expand Up @@ -1150,6 +1153,8 @@ changes:
times.
-->

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

* `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()`.
Expand Down Expand Up @@ -1244,6 +1249,8 @@ changes:
when no query string is present.
-->

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

* `urlString` {string} The URL string to parse.
* `parseQueryString` {boolean} If `true`, the `query` property will always
be set to an object returned by the [`querystring`][] module's `parse()`
Expand Down Expand Up @@ -1288,6 +1295,8 @@ changes:
contains a hostname.
-->

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

* `from` {string} The Base URL being resolved against.
* `to` {string} The HREF URL being resolved.

Expand Down