Skip to content

Commit 41e278b

Browse files
isaacldanielleadams
authored andcommitted
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 <[email protected]> Reviewed-By: Yash Ladha <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent 9b9b6d5 commit 41e278b

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

doc/api/punycode.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ deprecated: v7.0.0
1212
**The version of the punycode module bundled in Node.js is being deprecated**.
1313
In a future major version of Node.js this module will be removed. Users
1414
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][].
1618

1719
The `punycode` module is a bundled version of the [Punycode.js][] module. It
1820
can be accessed using:
@@ -150,3 +152,5 @@ Returns a string identifying the current [Punycode.js][] version number.
150152

151153
[Punycode]: https://tools.ietf.org/html/rfc3492
152154
[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

Comments
 (0)