Punycode

自 v7.0.0 起已弃用

[稳定性: 0 - 已弃用]

稳定性: 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('node: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)

新增于: v0.5.1

• string <string>

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

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

punycode.encode(string)

新增于: v0.5.1

• string <string>

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

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

punycode.toASCII(domain)

新增于: v0.6.1

• domain <string>

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

新增于: v0.6.1

• 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

新增于: v0.7.0

punycode.ucs2.decode(string)

新增于: v0.7.0

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

新增于：v0.7.0

• codePoints <integer[]>

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

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

punycode.version

新增于：v0.6.1

• <string>

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