diff options
author | James M Snell <jasnell@gmail.com> | 2018-09-05 11:33:20 -0700 |
---|---|---|
committer | James M Snell <jasnell@gmail.com> | 2018-09-07 16:55:44 -0700 |
commit | 922a1b03b638e19d8d29efdaab93d5c9455c02ce (patch) | |
tree | a1c7a5b932242009e6afebe988c274336a37cb21 /doc/api | |
parent | c1483bac9496d341dc428105d3c3e4b07600a933 (diff) | |
download | android-node-v8-922a1b03b638e19d8d29efdaab93d5c9455c02ce.tar.gz android-node-v8-922a1b03b638e19d8d29efdaab93d5c9455c02ce.tar.bz2 android-node-v8-922a1b03b638e19d8d29efdaab93d5c9455c02ce.zip |
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')
-rw-r--r-- | doc/api/deprecations.md | 18 | ||||
-rw-r--r-- | doc/api/url.md | 17 |
2 files changed, 34 insertions, 1 deletions
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md index 10ffa49f4d..04ff5f5ca0 100644 --- a/doc/api/deprecations.md +++ b/doc/api/deprecations.md @@ -1050,6 +1050,16 @@ deprecated along with the undocumented aliases `crypto.prng()` and `crypto.rng()` in favor of [`crypto.randomBytes()`][] and will be removed in a future release. +<a id="DEP0116"></a> +### DEP0116: Legacy URL API + +Type: Documentation + +The [Legacy URL API][] is deprecated. This includes [`url.format()`][], +[`url.parse()`][], [`url.resolve()`][], and the [legacy `urlObject`][]. Please +use the [WHATWG URL API][] instead. + + [`--pending-deprecation`]: cli.html#cli_pending_deprecation [`Buffer.allocUnsafeSlow(size)`]: buffer.html#buffer_class_method_buffer_allocunsafeslow_size [`Buffer.from(array)`]: buffer.html#buffer_class_method_buffer_from_array @@ -1098,6 +1108,7 @@ future release. [`os.tmpdir()`]: os.html#os_os_tmpdir [`process.env`]: process.html#process_process_env [`punycode`]: punycode.html +[`REPLServer.clearBufferedCommand()`]: repl.html#repl_replserver_clearbufferedcommand [`require.extensions`]: modules.html#modules_require_extensions [`script.createCachedData()`]: vm.html#vm_script_createcacheddata [`setInterval()`]: timers.html#timers_setinterval_callback_delay_args @@ -1108,6 +1119,9 @@ future release. [`tls.TLSSocket`]: tls.html#tls_class_tls_tlssocket [`tls.checkServerIdentity()`]: tls.html#tls_tls_checkserveridentity_hostname_cert [`tls.createSecureContext()`]: tls.html#tls_tls_createsecurecontext_options +[`url.format()`]: url.html#url_url_format_urlobject +[`url.parse()`]: url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost +[`url.resolve()`]: url.html#url_url_resolve_from_to [`util._extend()`]: util.html#util_util_extend_target_source [`util.debug()`]: util.html#util_util_debug_string [`util.error()`]: util.html#util_util_error_strings @@ -1139,5 +1153,7 @@ future release. [alloc_unsafe_size]: buffer.html#buffer_class_method_buffer_allocunsafe_size [from_arraybuffer]: buffer.html#buffer_class_method_buffer_from_arraybuffer_byteoffset_length [from_string_encoding]: buffer.html#buffer_class_method_buffer_from_string_encoding +[Legacy URL API]: url.html#url_legacy_url_api +[legacy `urlObject`]: url.html#url_legacy_urlobject [NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf -[`REPLServer.clearBufferedCommand()`]: repl.html#repl_replserver_clearbufferedcommand +[WHATWG URL API]: url.html#url_the_whatwg_url_api diff --git a/doc/api/url.md b/doc/api/url.md index cd817bf304..33b99398ee 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` |