Punycode#

稳定性:0 - 已弃用

源代码: 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 字符,因此包含非 ASCII 字符的域名必须使用 Punycode 方案转换为 ASCII。例如,日语字符“例”翻译成英文单词“example”。国际化域名“例.com”(等同于“example.com”)由 Punycode 表示为 ASCII 字符串“xn--fsq.com”。

punycode 模块提供了 Punycode 标准的简单实现。

punycode 模块是 Node.js 使用的第三方依赖项,并作为便利功能提供给开发人员。模块的修复或其他修改必须指向 Punycode.js 项目。

punycode.decode(string)#

punycode.decode() 方法将 Punycode 字符串(仅包含 ASCII 字符)转换为等效的 Unicode 代码点字符串。

punycode.decode('maana-pta'); // 'mañana'
punycode.decode('--dqo34k'); // '☃-⌘' 

punycode.encode(string)#

punycode.encode() 方法将 Unicode 代码点字符串转换为 Punycode 字符串(仅包含 ASCII 字符)。

punycode.encode('mañana'); // 'maana-pta'
punycode.encode('☃-⌘'); // '--dqo34k' 

punycode.toASCII(domain)#

punycode.toASCII() 方法将表示国际化域名(IDN)的 Unicode 字符串转换为 Punycode。 仅域名中非 ASCII 部分会被转换。 对仅包含 ASCII 字符的字符串调用 punycode.toASCII() 不会有任何效果。

// encode domain names
punycode.toASCII('mañana.com');  // 'xn--maana-pta.com'
punycode.toASCII('☃-⌘.com');   // 'xn----dqo34k.com'
punycode.toASCII('example.com'); // 'example.com' 

punycode.toUnicode(domain)#

punycode.toUnicode() 方法将表示包含 Punycode 编码字符的域名的字符串转换为 Unicode。 仅域名中 Punycode 编码的部分会被转换。

// decode domain names
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)#

punycode.ucs2.decode() 方法返回一个数组,其中包含字符串中每个 Unicode 符号的数字代码点值。

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)#

punycode.ucs2.encode() 方法根据数字代码点值数组返回一个字符串。

punycode.ucs2.encode([0x61, 0x62, 0x63]); // 'abc'
punycode.ucs2.encode([0x1D306]); // '\uD834\uDF06' 

punycode.version#

返回一个字符串,标识当前 Punycode.js 版本号。