Commit 73c1999
docs: add references to punycode.md
Add references to related `url` functions in punycode.md. These provide
guidance to users who may be investigating the punycode module for URL
encoding.
PR-URL: #36761
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yash Ladha <yash@yashladha.in>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 3f43743 commit 73c1999
1 file changed
Lines changed: 5 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -12,7 +12,9 @@ deprecated: v7.0.0 | |||
| 12 | 12 | **The version of the punycode module bundled in Node.js is being deprecated**. | |
| 13 | 13 | In a future major version of Node.js this module will be removed. Users | |
| 14 | 14 | currently depending on the `punycode` module should switch to using the | |
| 15 | - userland-provided [Punycode.js][] module instead. | ||
| 15 | + userland-provided [Punycode.js][] module instead. For punycode-based URL | ||
| 16 | + encoding, see [`url.domainToASCII`][] or, more generally, the | ||
| 17 | + [WHATWG URL API][]. | ||
| 16 | 18 | ||
| 17 | 19 | The `punycode` module is a bundled version of the [Punycode.js][] module. It | |
| 18 | 20 | can be accessed using: | |
@@ -150,3 +152,5 @@ Returns a string identifying the current [Punycode.js][] version number. | |||
| 150 | 152 | ||
| 151 | 153 | [Punycode]: https://tools.ietf.org/html/rfc3492 | |
| 152 | 154 | [Punycode.js]: https://github.com/bestiejs/punycode.js | |
| 155 | + [WHATWG URL API]: url.md#url_the_whatwg_url_api | ||
| 156 | + [`url.domainToASCII`]: url.md#url_url_domaintoascii_domain | ||
0 commit comments