mirror of
https://github.com/nodejs/node.git
synced 2025-05-21 10:42:18 +00:00
a69ab27ab4
This commit replaces instances of io.js with Node.js, based on the recent convergence. There are some remaining instances of io.js, related to build and the installer. Fixes: https://github.com/nodejs/node/issues/2361 PR-URL: https://github.com/nodejs/node/pull/2367 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com>
69 lines
2.3 KiB
Markdown
69 lines
2.3 KiB
Markdown
# punycode
|
|
|
|
Stability: 2 - Stable
|
|
|
|
[Punycode.js](https://mths.be/punycode) is bundled with Node.js v0.6.2+. 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)
|
|
|
|
Converts a Punycode string of ASCII-only symbols to a string of Unicode symbols.
|
|
|
|
// decode domain name parts
|
|
punycode.decode('maana-pta'); // 'mañana'
|
|
punycode.decode('--dqo34k'); // '☃-⌘'
|
|
|
|
## punycode.encode(string)
|
|
|
|
Converts a string of Unicode symbols to a Punycode string of ASCII-only symbols.
|
|
|
|
// encode domain name parts
|
|
punycode.encode('mañana'); // 'maana-pta'
|
|
punycode.encode('☃-⌘'); // '--dqo34k'
|
|
|
|
## punycode.toUnicode(domain)
|
|
|
|
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.
|
|
|
|
// decode domain names
|
|
punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
|
|
punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'
|
|
|
|
## punycode.toASCII(domain)
|
|
|
|
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.
|
|
|
|
// encode domain names
|
|
punycode.toASCII('mañana.com'); // 'xn--maana-pta.com'
|
|
punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'
|
|
|
|
## punycode.ucs2
|
|
|
|
### punycode.ucs2.decode(string)
|
|
|
|
Creates an array containing the numeric code point values of each Unicode
|
|
symbol in the string. While [JavaScript uses UCS-2
|
|
internally](http://mathiasbynens.be/notes/javascript-encoding), 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.
|
|
|
|
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)
|
|
|
|
Creates a string based on an array of numeric code point values.
|
|
|
|
punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'
|
|
punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06'
|
|
|
|
## punycode.version
|
|
|
|
A string representing the current Punycode.js version number.
|