Node.js v26.0.0 文档

Punycode#

Node.js 中捆绑的 punycode 模块版本已被弃用。在 Node.js 的未来主要版本中，该模块将被移除。当前依赖 punycode 模块的用户应转而使用用户空间提供的 Punycode.js 模块。有关基于 Punycode 的 URL 编码，请参阅 url.domainToASCII，或更通用的 WHATWG URL API。

punycode 模块是 Punycode.js 模块的捆绑版本。可以通过以下方式访问：

const punycode = require('node:punycode');
copy

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

• string <string>

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

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

punycode.encode(string)#

• string <string>

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

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

punycode.toASCII(domain)#

• domain <string>

punycode.toASCII() 方法将表示国际化域名的 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'
copy

punycode.toUnicode(domain)#

• domain <string>

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'
copy

punycode.ucs2#

punycode.ucs2.decode(string)#

• string <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]
copy

punycode.ucs2.encode(codePoints)#

• codePoints <integer[]>

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

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

punycode.version#

• 类型：<string>

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