1<!DOCTYPE html> 2<html lang="en"> 3<head> 4 <meta charset="utf-8"> 5 <meta name="viewport" content="width=device-width"> 6 <meta name="nodejs.org:node-version" content="v18.20.1"> 7 <title>Punycode | Node.js v18.20.1 Documentation</title> 8 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback"> 9 <link rel="stylesheet" href="assets/style.css"> 10 <link rel="stylesheet" href="assets/hljs.css"> 11 <link rel="canonical" href="https://nodejs.org/api/punycode.html"> 12 <script async defer src="assets/api.js" type="text/javascript"></script> 13 14</head> 15<body class="alt apidoc" id="api-section-punycode"> 16 <div id="content" class="clearfix"> 17 <div id="column2" class="interior"> 18 <div id="intro" class="interior"> 19 <a href="/" title="Go back to the home page"> 20 Node.js 21 </a> 22 </div> 23 <ul> 24<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 25<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 26</ul> 27<hr class="line"> 28<ul> 29<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 30<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 31<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 32<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 33<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 34<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 35<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 36<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 37<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 38<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 39<li><a href="console.html" class="nav-console">Console</a></li> 40<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 41<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 42<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 43<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 44<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 45<li><a href="dns.html" class="nav-dns">DNS</a></li> 46<li><a href="domain.html" class="nav-domain">Domain</a></li> 47<li><a href="errors.html" class="nav-errors">Errors</a></li> 48<li><a href="events.html" class="nav-events">Events</a></li> 49<li><a href="fs.html" class="nav-fs">File system</a></li> 50<li><a href="globals.html" class="nav-globals">Globals</a></li> 51<li><a href="http.html" class="nav-http">HTTP</a></li> 52<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 53<li><a href="https.html" class="nav-https">HTTPS</a></li> 54<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 55<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 56<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 57<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 58<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 59<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 60<li><a href="net.html" class="nav-net">Net</a></li> 61<li><a href="os.html" class="nav-os">OS</a></li> 62<li><a href="path.html" class="nav-path">Path</a></li> 63<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 64<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 65<li><a href="process.html" class="nav-process">Process</a></li> 66<li><a href="punycode.html" class="nav-punycode active">Punycode</a></li> 67<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 68<li><a href="readline.html" class="nav-readline">Readline</a></li> 69<li><a href="repl.html" class="nav-repl">REPL</a></li> 70<li><a href="report.html" class="nav-report">Report</a></li> 71<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 72<li><a href="stream.html" class="nav-stream">Stream</a></li> 73<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 74<li><a href="test.html" class="nav-test">Test runner</a></li> 75<li><a href="timers.html" class="nav-timers">Timers</a></li> 76<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 77<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 78<li><a href="tty.html" class="nav-tty">TTY</a></li> 79<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 80<li><a href="url.html" class="nav-url">URL</a></li> 81<li><a href="util.html" class="nav-util">Utilities</a></li> 82<li><a href="v8.html" class="nav-v8">V8</a></li> 83<li><a href="vm.html" class="nav-vm">VM</a></li> 84<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 85<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 86<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 87<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 88<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 89</ul> 90<hr class="line"> 91<ul> 92<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 93</ul> 94 </div> 95 96 <div id="column1" data-id="punycode" class="interior"> 97 <header class="header"> 98 <div class="header-container"> 99 <h1>Node.js v18.20.1 documentation</h1> 100 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden> 101 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24"> 102 <path fill="none" d="M0 0h24v24H0z" /> 103 <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/> 104 <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/> 105 </svg> 106 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24"> 107 <path d="M0 0h24v24H0z" fill="none" /> 108 <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/> 109 </svg> 110 </button> 111 </div> 112 <div id="gtoc"> 113 <ul> 114 <li class="pinned-header">Node.js v18.20.1</li> 115 116 <li class="picker-header"> 117 <a href="#"> 118 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 119 Table of contents 120 </a> 121 122 <div class="picker"><div class="toc"><ul> 123<li><span class="stability_0"><a href="#punycode">Punycode</a></span> 124<ul> 125<li><a href="#punycodedecodestring"><code>punycode.decode(string)</code></a></li> 126<li><a href="#punycodeencodestring"><code>punycode.encode(string)</code></a></li> 127<li><a href="#punycodetoasciidomain"><code>punycode.toASCII(domain)</code></a></li> 128<li><a href="#punycodetounicodedomain"><code>punycode.toUnicode(domain)</code></a></li> 129<li><a href="#punycodeucs2"><code>punycode.ucs2</code></a> 130<ul> 131<li><a href="#punycodeucs2decodestring"><code>punycode.ucs2.decode(string)</code></a></li> 132<li><a href="#punycodeucs2encodecodepoints"><code>punycode.ucs2.encode(codePoints)</code></a></li> 133</ul> 134</li> 135<li><a href="#punycodeversion"><code>punycode.version</code></a></li> 136</ul> 137</li> 138</ul></div></div> 139 </li> 140 141 142 <li class="picker-header"> 143 <a href="#"> 144 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 145 Index 146 </a> 147 148 <div class="picker"><ul> 149<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li> 150<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li> 151 152 <li> 153 <a href="index.html">Index</a> 154 </li> 155 </ul> 156 157<hr class="line"> 158<ul> 159<li><a href="assert.html" class="nav-assert">Assertion testing</a></li> 160<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li> 161<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li> 162<li><a href="buffer.html" class="nav-buffer">Buffer</a></li> 163<li><a href="addons.html" class="nav-addons">C++ addons</a></li> 164<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li> 165<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li> 166<li><a href="child_process.html" class="nav-child_process">Child processes</a></li> 167<li><a href="cluster.html" class="nav-cluster">Cluster</a></li> 168<li><a href="cli.html" class="nav-cli">Command-line options</a></li> 169<li><a href="console.html" class="nav-console">Console</a></li> 170<li><a href="corepack.html" class="nav-corepack">Corepack</a></li> 171<li><a href="crypto.html" class="nav-crypto">Crypto</a></li> 172<li><a href="debugger.html" class="nav-debugger">Debugger</a></li> 173<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li> 174<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li> 175<li><a href="dns.html" class="nav-dns">DNS</a></li> 176<li><a href="domain.html" class="nav-domain">Domain</a></li> 177<li><a href="errors.html" class="nav-errors">Errors</a></li> 178<li><a href="events.html" class="nav-events">Events</a></li> 179<li><a href="fs.html" class="nav-fs">File system</a></li> 180<li><a href="globals.html" class="nav-globals">Globals</a></li> 181<li><a href="http.html" class="nav-http">HTTP</a></li> 182<li><a href="http2.html" class="nav-http2">HTTP/2</a></li> 183<li><a href="https.html" class="nav-https">HTTPS</a></li> 184<li><a href="inspector.html" class="nav-inspector">Inspector</a></li> 185<li><a href="intl.html" class="nav-intl">Internationalization</a></li> 186<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li> 187<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li> 188<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li> 189<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li> 190<li><a href="net.html" class="nav-net">Net</a></li> 191<li><a href="os.html" class="nav-os">OS</a></li> 192<li><a href="path.html" class="nav-path">Path</a></li> 193<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li> 194<li><a href="permissions.html" class="nav-permissions">Permissions</a></li> 195<li><a href="process.html" class="nav-process">Process</a></li> 196<li><a href="punycode.html" class="nav-punycode active">Punycode</a></li> 197<li><a href="querystring.html" class="nav-querystring">Query strings</a></li> 198<li><a href="readline.html" class="nav-readline">Readline</a></li> 199<li><a href="repl.html" class="nav-repl">REPL</a></li> 200<li><a href="report.html" class="nav-report">Report</a></li> 201<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li> 202<li><a href="stream.html" class="nav-stream">Stream</a></li> 203<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li> 204<li><a href="test.html" class="nav-test">Test runner</a></li> 205<li><a href="timers.html" class="nav-timers">Timers</a></li> 206<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li> 207<li><a href="tracing.html" class="nav-tracing">Trace events</a></li> 208<li><a href="tty.html" class="nav-tty">TTY</a></li> 209<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li> 210<li><a href="url.html" class="nav-url">URL</a></li> 211<li><a href="util.html" class="nav-util">Utilities</a></li> 212<li><a href="v8.html" class="nav-v8">V8</a></li> 213<li><a href="vm.html" class="nav-vm">VM</a></li> 214<li><a href="wasi.html" class="nav-wasi">WASI</a></li> 215<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li> 216<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li> 217<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li> 218<li><a href="zlib.html" class="nav-zlib">Zlib</a></li> 219</ul> 220<hr class="line"> 221<ul> 222<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li> 223</ul></div> 224 </li> 225 226 227 <li class="picker-header"> 228 <a href="#"> 229 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 230 Other versions 231 </a> 232 <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v21.x/api/punycode.html">21.x</a></li> 233<li><a href="https://nodejs.org/docs/latest-v20.x/api/punycode.html">20.x <b>LTS</b></a></li> 234<li><a href="https://nodejs.org/docs/latest-v19.x/api/punycode.html">19.x</a></li> 235<li><a href="https://nodejs.org/docs/latest-v18.x/api/punycode.html">18.x <b>LTS</b></a></li> 236<li><a href="https://nodejs.org/docs/latest-v17.x/api/punycode.html">17.x</a></li> 237<li><a href="https://nodejs.org/docs/latest-v16.x/api/punycode.html">16.x</a></li> 238<li><a href="https://nodejs.org/docs/latest-v15.x/api/punycode.html">15.x</a></li> 239<li><a href="https://nodejs.org/docs/latest-v14.x/api/punycode.html">14.x</a></li> 240<li><a href="https://nodejs.org/docs/latest-v13.x/api/punycode.html">13.x</a></li> 241<li><a href="https://nodejs.org/docs/latest-v12.x/api/punycode.html">12.x</a></li> 242<li><a href="https://nodejs.org/docs/latest-v11.x/api/punycode.html">11.x</a></li> 243<li><a href="https://nodejs.org/docs/latest-v10.x/api/punycode.html">10.x</a></li> 244<li><a href="https://nodejs.org/docs/latest-v9.x/api/punycode.html">9.x</a></li> 245<li><a href="https://nodejs.org/docs/latest-v8.x/api/punycode.html">8.x</a></li> 246<li><a href="https://nodejs.org/docs/latest-v7.x/api/punycode.html">7.x</a></li> 247<li><a href="https://nodejs.org/docs/latest-v6.x/api/punycode.html">6.x</a></li> 248<li><a href="https://nodejs.org/docs/latest-v5.x/api/punycode.html">5.x</a></li> 249<li><a href="https://nodejs.org/docs/latest-v4.x/api/punycode.html">4.x</a></li> 250<li><a href="https://nodejs.org/docs/latest-v0.12.x/api/punycode.html">0.12.x</a></li> 251<li><a href="https://nodejs.org/docs/latest-v0.10.x/api/punycode.html">0.10.x</a></li></ol></div> 252 </li> 253 254 <li class="picker-header"> 255 <a href="#"> 256 <span class="collapsed-arrow">►</span><span class="expanded-arrow">▼</span> 257 Options 258 </a> 259 260 <div class="picker"> 261 <ul> 262 <li> 263 <a href="all.html">View on single page</a> 264 </li> 265 <li> 266 <a href="punycode.json">View as JSON</a> 267 </li> 268 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/punycode.md">Edit on GitHub</a></li> 269 </ul> 270 </div> 271 </li> 272 </ul> 273 </div> 274 <hr> 275 </header> 276 277 <details id="toc" open><summary>Table of contents</summary><ul> 278<li><span class="stability_0"><a href="#punycode">Punycode</a></span> 279<ul> 280<li><a href="#punycodedecodestring"><code>punycode.decode(string)</code></a></li> 281<li><a href="#punycodeencodestring"><code>punycode.encode(string)</code></a></li> 282<li><a href="#punycodetoasciidomain"><code>punycode.toASCII(domain)</code></a></li> 283<li><a href="#punycodetounicodedomain"><code>punycode.toUnicode(domain)</code></a></li> 284<li><a href="#punycodeucs2"><code>punycode.ucs2</code></a> 285<ul> 286<li><a href="#punycodeucs2decodestring"><code>punycode.ucs2.decode(string)</code></a></li> 287<li><a href="#punycodeucs2encodecodepoints"><code>punycode.ucs2.encode(codePoints)</code></a></li> 288</ul> 289</li> 290<li><a href="#punycodeversion"><code>punycode.version</code></a></li> 291</ul> 292</li> 293</ul></details> 294 295 <div id="apicontent"> 296 <h2>Punycode<span><a class="mark" href="#punycode" id="punycode">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode"></a></h2> 297<div class="api_metadata"> 298<span>Deprecated since: v7.0.0</span> 299</div> 300 301<p></p><div class="api_stability api_stability_0"><a href="documentation.html#stability-index">Stability: 0</a> - Deprecated</div><p></p> 302<p><strong>Source Code:</strong> <a href="https://github.com/nodejs/node/blob/v18.20.1/lib/punycode.js">lib/punycode.js</a></p> 303<p><strong>The version of the punycode module bundled in Node.js is being deprecated.</strong> 304In a future major version of Node.js this module will be removed. Users 305currently depending on the <code>punycode</code> module should switch to using the 306userland-provided <a href="https://github.com/bestiejs/punycode.js">Punycode.js</a> module instead. For punycode-based URL 307encoding, see <a href="url.html#urldomaintoasciidomain"><code>url.domainToASCII</code></a> or, more generally, the 308<a href="url.html#the-whatwg-url-api">WHATWG URL API</a>.</p> 309<p>The <code>punycode</code> module is a bundled version of the <a href="https://github.com/bestiejs/punycode.js">Punycode.js</a> module. It 310can be accessed using:</p> 311<pre><code class="language-js"><span class="hljs-keyword">const</span> punycode = <span class="hljs-built_in">require</span>(<span class="hljs-string">'punycode'</span>);</code> <button class="copy-button">copy</button></pre> 312<p><a href="https://tools.ietf.org/html/rfc3492">Punycode</a> is a character encoding scheme defined by RFC 3492 that is 313primarily intended for use in Internationalized Domain Names. Because host 314names in URLs are limited to ASCII characters only, Domain Names that contain 315non-ASCII characters must be converted into ASCII using the Punycode scheme. 316For instance, the Japanese character that translates into the English word, 317<code>'example'</code> is <code>'例'</code>. The Internationalized Domain Name, <code>'例.com'</code> (equivalent 318to <code>'example.com'</code>) is represented by Punycode as the ASCII string 319<code>'xn--fsq.com'</code>.</p> 320<p>The <code>punycode</code> module provides a simple implementation of the Punycode standard.</p> 321<p>The <code>punycode</code> module is a third-party dependency used by Node.js and 322made available to developers as a convenience. Fixes or other modifications to 323the module must be directed to the <a href="https://github.com/bestiejs/punycode.js">Punycode.js</a> project.</p> 324<section><h3><code>punycode.decode(string)</code><span><a class="mark" href="#punycodedecodestring" id="punycodedecodestring">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode_decode_string"></a></h3> 325<div class="api_metadata"> 326<span>Added in: v0.5.1</span> 327</div> 328<ul> 329<li><code>string</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 330</ul> 331<p>The <code>punycode.decode()</code> method converts a <a href="https://tools.ietf.org/html/rfc3492">Punycode</a> string of ASCII-only 332characters to the equivalent string of Unicode codepoints.</p> 333<pre><code class="language-js">punycode.<span class="hljs-title function_">decode</span>(<span class="hljs-string">'maana-pta'</span>); <span class="hljs-comment">// 'mañana'</span> 334punycode.<span class="hljs-title function_">decode</span>(<span class="hljs-string">'--dqo34k'</span>); <span class="hljs-comment">// '☃-⌘'</span></code> <button class="copy-button">copy</button></pre> 335</section><section><h3><code>punycode.encode(string)</code><span><a class="mark" href="#punycodeencodestring" id="punycodeencodestring">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode_encode_string"></a></h3> 336<div class="api_metadata"> 337<span>Added in: v0.5.1</span> 338</div> 339<ul> 340<li><code>string</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 341</ul> 342<p>The <code>punycode.encode()</code> method converts a string of Unicode codepoints to a 343<a href="https://tools.ietf.org/html/rfc3492">Punycode</a> string of ASCII-only characters.</p> 344<pre><code class="language-js">punycode.<span class="hljs-title function_">encode</span>(<span class="hljs-string">'mañana'</span>); <span class="hljs-comment">// 'maana-pta'</span> 345punycode.<span class="hljs-title function_">encode</span>(<span class="hljs-string">'☃-⌘'</span>); <span class="hljs-comment">// '--dqo34k'</span></code> <button class="copy-button">copy</button></pre> 346</section><section><h3><code>punycode.toASCII(domain)</code><span><a class="mark" href="#punycodetoasciidomain" id="punycodetoasciidomain">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode_toascii_domain"></a></h3> 347<div class="api_metadata"> 348<span>Added in: v0.6.1</span> 349</div> 350<ul> 351<li><code>domain</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 352</ul> 353<p>The <code>punycode.toASCII()</code> method converts a Unicode string representing an 354Internationalized Domain Name to <a href="https://tools.ietf.org/html/rfc3492">Punycode</a>. Only the non-ASCII parts of the 355domain name will be converted. Calling <code>punycode.toASCII()</code> on a string that 356already only contains ASCII characters will have no effect.</p> 357<pre><code class="language-js"><span class="hljs-comment">// encode domain names</span> 358punycode.<span class="hljs-title function_">toASCII</span>(<span class="hljs-string">'mañana.com'</span>); <span class="hljs-comment">// 'xn--maana-pta.com'</span> 359punycode.<span class="hljs-title function_">toASCII</span>(<span class="hljs-string">'☃-⌘.com'</span>); <span class="hljs-comment">// 'xn----dqo34k.com'</span> 360punycode.<span class="hljs-title function_">toASCII</span>(<span class="hljs-string">'example.com'</span>); <span class="hljs-comment">// 'example.com'</span></code> <button class="copy-button">copy</button></pre> 361</section><section><h3><code>punycode.toUnicode(domain)</code><span><a class="mark" href="#punycodetounicodedomain" id="punycodetounicodedomain">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode_tounicode_domain"></a></h3> 362<div class="api_metadata"> 363<span>Added in: v0.6.1</span> 364</div> 365<ul> 366<li><code>domain</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 367</ul> 368<p>The <code>punycode.toUnicode()</code> method converts a string representing a domain name 369containing <a href="https://tools.ietf.org/html/rfc3492">Punycode</a> encoded characters into Unicode. Only the <a href="https://tools.ietf.org/html/rfc3492">Punycode</a> 370encoded parts of the domain name are be converted.</p> 371<pre><code class="language-js"><span class="hljs-comment">// decode domain names</span> 372punycode.<span class="hljs-title function_">toUnicode</span>(<span class="hljs-string">'xn--maana-pta.com'</span>); <span class="hljs-comment">// 'mañana.com'</span> 373punycode.<span class="hljs-title function_">toUnicode</span>(<span class="hljs-string">'xn----dqo34k.com'</span>); <span class="hljs-comment">// '☃-⌘.com'</span> 374punycode.<span class="hljs-title function_">toUnicode</span>(<span class="hljs-string">'example.com'</span>); <span class="hljs-comment">// 'example.com'</span></code> <button class="copy-button">copy</button></pre> 375</section><section><h3><code>punycode.ucs2</code><span><a class="mark" href="#punycodeucs2" id="punycodeucs2">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode_ucs2"></a></h3> 376<div class="api_metadata"> 377<span>Added in: v0.7.0</span> 378</div> 379<h4><code>punycode.ucs2.decode(string)</code><span><a class="mark" href="#punycodeucs2decodestring" id="punycodeucs2decodestring">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode_ucs2_decode_string"></a></h4> 380<div class="api_metadata"> 381<span>Added in: v0.7.0</span> 382</div> 383<ul> 384<li><code>string</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 385</ul> 386<p>The <code>punycode.ucs2.decode()</code> method returns an array containing the numeric 387codepoint values of each Unicode symbol in the string.</p> 388<pre><code class="language-js">punycode.<span class="hljs-property">ucs2</span>.<span class="hljs-title function_">decode</span>(<span class="hljs-string">'abc'</span>); <span class="hljs-comment">// [0x61, 0x62, 0x63]</span> 389<span class="hljs-comment">// surrogate pair for U+1D306 tetragram for centre:</span> 390punycode.<span class="hljs-property">ucs2</span>.<span class="hljs-title function_">decode</span>(<span class="hljs-string">'\uD834\uDF06'</span>); <span class="hljs-comment">// [0x1D306]</span></code> <button class="copy-button">copy</button></pre> 391<h4><code>punycode.ucs2.encode(codePoints)</code><span><a class="mark" href="#punycodeucs2encodecodepoints" id="punycodeucs2encodecodepoints">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode_ucs2_encode_codepoints"></a></h4> 392<div class="api_metadata"> 393<span>Added in: v0.7.0</span> 394</div> 395<ul> 396<li><code>codePoints</code> <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Number_type" class="type"><integer[]></a></li> 397</ul> 398<p>The <code>punycode.ucs2.encode()</code> method returns a string based on an array of 399numeric code point values.</p> 400<pre><code class="language-js">punycode.<span class="hljs-property">ucs2</span>.<span class="hljs-title function_">encode</span>([<span class="hljs-number">0x61</span>, <span class="hljs-number">0x62</span>, <span class="hljs-number">0x63</span>]); <span class="hljs-comment">// 'abc'</span> 401punycode.<span class="hljs-property">ucs2</span>.<span class="hljs-title function_">encode</span>([<span class="hljs-number">0x1D306</span>]); <span class="hljs-comment">// '\uD834\uDF06'</span></code> <button class="copy-button">copy</button></pre> 402</section><section><h3><code>punycode.version</code><span><a class="mark" href="#punycodeversion" id="punycodeversion">#</a></span><a aria-hidden="true" class="legacy" id="punycode_punycode_version"></a></h3> 403<div class="api_metadata"> 404<span>Added in: v0.6.1</span> 405</div> 406<ul> 407<li><a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#String_type" class="type"><string></a></li> 408</ul> 409<p>Returns a string identifying the current <a href="https://github.com/bestiejs/punycode.js">Punycode.js</a> version number.</p></section> 410 <!-- API END --> 411 </div> 412 </div> 413 </div> 414</body> 415</html> 416