diff options
author | James M Snell <jasnell@gmail.com> | 2018-09-05 21:33:20 +0300 |
---|---|---|
committer | James M Snell <jasnell@gmail.com> | 2018-09-08 02:55:44 +0300 |
commit | 922a1b03b638e19d8d29efdaab93d5c9455c02ce (patch) | |
tree | a1c7a5b932242009e6afebe988c274336a37cb21 /doc/api/url.md | |
parent | c1483bac9496d341dc428105d3c3e4b07600a933 (diff) |
url: docs deprecate legacy url API
PR-URL: https://github.com/nodejs/node/pull/22715
Reviewed-By: Michaƫl Zasso <targos@protonmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc/api/url.md')
-rw-r--r-- | doc/api/url.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/api/url.md b/doc/api/url.md index cd817bf304b..33b99398eee 100644 --- a/doc/api/url.md +++ b/doc/api/url.md @@ -964,7 +964,15 @@ pathToFileURL('/some/path%.js'); // Correct: file:///some/path%25 (POSIX) ## Legacy URL API +> Stability: 0 - Deprecated: Use the WHATWG URL API instead. + ### Legacy `urlObject` +<!-- YAML +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/22715 + description: The Legacy URL API is deprecated. Use the WHATWG URL API. +--> The legacy `urlObject` (`require('url').Url`) is created and returned by the `url.parse()` function. @@ -1070,6 +1078,9 @@ forward-slash characters (`/`) are required following the colon in the <!-- YAML added: v0.1.25 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/22715 + description: The Legacy URL API is deprecated. Use the WHATWG URL API. - version: v7.0.0 pr-url: https://github.com/nodejs/node/pull/7234 description: URLs with a `file:` scheme will now always use the correct @@ -1158,6 +1169,9 @@ The formatting process operates as follows: <!-- YAML added: v0.1.25 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/22715 + description: The Legacy URL API is deprecated. Use the WHATWG URL API. - version: v9.0.0 pr-url: https://github.com/nodejs/node/pull/13606 description: The `search` property on the returned URL object is now `null` @@ -1186,6 +1200,9 @@ A `URIError` is thrown if the `auth` property is present but cannot be decoded. <!-- YAML added: v0.1.25 changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/22715 + description: The Legacy URL API is deprecated. Use the WHATWG URL API. - version: v6.6.0 pr-url: https://github.com/nodejs/node/pull/8215 description: The `auth` fields are now kept intact when `from` and `to` |