源代码: lib/punycode.js
Node.js 中捆绑的 punycode 模块的版本已被弃用。 在 Node.js 的未来主版本中,此模块将被删除。
当前依赖 punycode
模块的用户应该改用用户区提供的 Punycode.js 模块。
对于基于 punycode 的 URL 编码,请参阅 url.domainToASCII
,或更一般地说,WHATWG URL API。
punycode
模块是 Punycode.js 模块的捆绑版本。
可以使用以下方式访问它:
const punycode = require('punycode');
Punycode 是 RFC 3492 定义的字符编码方案,主要用于国际化域名。
由于 URL 中的主机名仅限于 ASCII 字符,因此必须使用 Punycode 方案将包含非 ASCII 字符的域名转换为 ASCII。
例如,翻译成英文单词的日文字符 'example'
是 '例'
。
国际化域名 '例.com'
(相当于 'example.com'
)由 Punycode 表示为 ASCII 字符串 'xn--fsq.com'
。
punycode
模块提供了 Punycode 标准的简单实现。
punycode
模块是 Node.js 使用的第三方依赖项,为方便开发者提供。
对模块的修复或其他修改必须指向 Punycode.js 项目。
punycode.decode(string)
#string
<string>punycode.decode()
方法将纯 ASCII 字符的 Punycode 字符串转换为等效的 Unicode 代码点字符串。
punycode.decode('maana-pta'); // 'mañana'
punycode.decode('--dqo34k'); // '☃-⌘'
punycode.encode(string)
#string
<string>punycode.encode()
方法将一串 Unicode 代码点转换为仅包含 ASCII 字符的 Punycode 字符串。
punycode.encode('mañana'); // 'maana-pta'
punycode.encode('☃-⌘'); // '--dqo34k'
punycode.toASCII(domain)
#domain
<string>punycode.toASCII()
方法将表示国际化域名的 Unicode 字符串转换为 Punycode。
只转换域名的非 ASCII 部分。
在已经只包含 ASCII 字符的字符串上调用 punycode.toASCII()
将无效。
// 编码域名
punycode.toASCII('mañana.com'); // 'xn--maana-pta.com'
punycode.toASCII('☃-⌘.com'); // 'xn----dqo34k.com'
punycode.toASCII('example.com'); // 'example.com'
punycode.toUnicode(domain)
#domain
<string>punycode.toUnicode()
方法将表示包含 Punycode 编码字符的域名的字符串转换为 Unicode。
只转换域名的 Punycode 编码部分。
// 解码域名
punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
punycode.toUnicode('xn----dqo34k.com'); // '☃-⌘.com'
punycode.toUnicode('example.com'); // 'example.com'
punycode.ucs2
#punycode.ucs2.decode(string)
#string
<string>punycode.ucs2.decode()
方法返回一个数组,其中包含字符串中每个 Unicode 符号的数字代码点值。
punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]
// U+1D306 中心四元组的代理对:
punycode.ucs2.decode('\uD834\uDF06'); // [0x1D306]
punycode.ucs2.encode(codePoints)
#codePoints
<integer[]>punycode.ucs2.encode()
方法返回基于数字代码点值数组的字符串。
punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'
punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06'
punycode.version
#返回标识当前 Punycode.js 版本号的字符串。