30d9202f54Unify capitalization and spaces and add some info for consistency, clarity and coherence with sorting in the all.md / _toc.md. PR-URL: https://github.com/nodejs/node/pull/11230 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Timothy Gu <timothygu99@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
106 lines
2.6 KiB
Markdown
106 lines
2.6 KiB
Markdown
# Punycode
|
|
|
|
> Stability: 2 - Stable
|
|
|
|
[Punycode.js][] is bundled with Node.js v0.5.1+. Use `require('punycode')` to
|
|
access it. (To use it with other Node.js versions, use npm to install the
|
|
`punycode` module first.)
|
|
|
|
## punycode.decode(string)
|
|
<!-- YAML
|
|
added: v0.5.1
|
|
-->
|
|
|
|
Converts a Punycode string of ASCII-only symbols to a string of Unicode symbols.
|
|
|
|
```js
|
|
// decode domain name parts
|
|
punycode.decode('maana-pta'); // 'mañana'
|
|
punycode.decode('--dqo34k'); // '☃-⌘'
|
|
```
|
|
|
|
## punycode.encode(string)
|
|
<!-- YAML
|
|
added: v0.5.1
|
|
-->
|
|
|
|
Converts a string of Unicode symbols to a Punycode string of ASCII-only symbols.
|
|
|
|
```js
|
|
// encode domain name parts
|
|
punycode.encode('mañana'); // 'maana-pta'
|
|
punycode.encode('☃-⌘'); // '--dqo34k'
|
|
```
|
|
|
|
## punycode.toASCII(domain)
|
|
<!-- YAML
|
|
added: v0.6.1
|
|
-->
|
|
|
|
Converts a Unicode string representing a domain name to Punycode. Only the
|
|
non-ASCII parts of the domain name will be converted, i.e. it doesn't matter if
|
|
you call it with a domain that's already in ASCII.
|
|
|
|
```js
|
|
// encode domain names
|
|
punycode.toASCII('mañana.com'); // 'xn--maana-pta.com'
|
|
punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'
|
|
```
|
|
|
|
## punycode.toUnicode(domain)
|
|
<!-- YAML
|
|
added: v0.6.1
|
|
-->
|
|
|
|
Converts a Punycode string representing a domain name to Unicode. Only the
|
|
Punycoded parts of the domain name will be converted, i.e. it doesn't matter if
|
|
you call it on a string that has already been converted to Unicode.
|
|
|
|
```js
|
|
// decode domain names
|
|
punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
|
|
punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'
|
|
```
|
|
|
|
## punycode.ucs2
|
|
<!-- YAML
|
|
added: v0.7.0
|
|
-->
|
|
|
|
### punycode.ucs2.decode(string)
|
|
<!-- YAML
|
|
added: v0.7.0
|
|
-->
|
|
|
|
Creates an array containing the numeric code point values of each Unicode
|
|
symbol in the string. While [JavaScript uses UCS-2 internally][], this function
|
|
will convert a pair of surrogate halves (each of which UCS-2 exposes as
|
|
separate characters) into a single code point, matching UTF-16.
|
|
|
|
```js
|
|
punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]
|
|
// surrogate pair for U+1D306 tetragram for centre:
|
|
punycode.ucs2.decode('\uD834\uDF06'); // [0x1D306]
|
|
```
|
|
|
|
### punycode.ucs2.encode(codePoints)
|
|
<!-- YAML
|
|
added: v0.7.0
|
|
-->
|
|
|
|
Creates a string based on an array of numeric code point values.
|
|
|
|
```js
|
|
punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'
|
|
punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06'
|
|
```
|
|
|
|
## punycode.version
|
|
<!-- YAML
|
|
added: v0.6.1
|
|
-->
|
|
|
|
A string representing the current Punycode.js version number.
|
|
|
|
[Punycode.js]: https://mths.be/punycode
|
|
[JavaScript uses UCS-2 internally]: https://mathiasbynens.be/notes/javascript-encoding
|