Skip to content

Commit

Permalink
doc: add deprecated badge to legacy URL methods
Browse files Browse the repository at this point in the history
PR-URL: #34931
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
  • Loading branch information
aduh95 authored and richardlau committed Sep 7, 2020
1 parent 577978a commit 0ac7d54
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions doc/api/url.md
Original file line number Diff line number Diff line change
Expand Up @@ -1006,8 +1006,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 @@ -1017,6 +1018,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 @@ -1132,6 +1135,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 @@ -1226,6 +1231,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 @@ -1270,6 +1277,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

0 comments on commit 0ac7d54

Please sign in to comment.