Skip to content

Commit

Permalink
docs: add references to punycode.md
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
isaacl authored and jasnell committed Jan 9, 2021
1 parent 83b428a commit 7dea99b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/api/punycode.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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

0 comments on commit 7dea99b

Please sign in to comment.