1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add references to punycode.md

Browse Source 
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: https://github.com/nodejs/node/pull/36761
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Yash Ladha <yash@yashladha.in>
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Isaac Levy 2021-01-03 16:11:29 -05:00 committed by James M Snell
parent 83b428a954
commit 7dea99b1e6
No known key found for this signature in database
GPG Key ID: 7341B15C070877AC
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/api/punycode.md
View File

@ -12,7 +12,9 @@ deprecated: v7.0.0
**The version of the punycode module bundled in Node.js is being deprecated**.
In a future major version of Node.js this module will be removed. Users
currently depending on the `punycode` module should switch to using the
userland-provided [Punycode.js][] module instead.
userland-provided [Punycode.js][] module instead. For punycode-based URL
encoding, see [`url.domainToASCII`][] or, more generally, the
[WHATWG URL API][].
The `punycode` module is a bundled version of the [Punycode.js][] module. It
can be accessed using:
@ -150,3 +152,5 @@ Returns a string identifying the current [Punycode.js][] version number.
[Punycode]: https://tools.ietf.org/html/rfc3492
[Punycode.js]: https://github.com/bestiejs/punycode.js
[WHATWG URL API]: url.md#url_the_whatwg_url_api
[`url.domainToASCII`]: url.md#url_url_domaintoascii_domain