diff options
| author | Antoine du HAMEL <duhamelantoine1995@gmail.com> | 2020-08-26 14:03:41 +0300 |
|---|---|---|
| committer | Derek Lewis <DerekNonGeneric@inf.is> | 2020-09-06 23:33:56 +0300 |
| commit | 181ba95819565f8f76acffe538d3f06a50499d05 (patch) | |
| tree | 2da0164c3b3504af1d90cdf964e913702c245b71 /doc/api/url.md | |
| parent | 441c03de50069d0c9662c87a3ecfd43837d39cae (diff) | |
doc: add deprecated badge to legacy URL methods
PR-URL: https://github.com/nodejs/node/pull/34931
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Guy Bedford <guybedford@gmail.com>
Diffstat (limited to 'doc/api/url.md')
| -rw-r--r-- | doc/api/url.md | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/api/url.md b/doc/api/url.md index 582deaceeb1..07600dc3bb7 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -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 @@ -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. @@ -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()`. @@ -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()` @@ -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. |