Punycode.js 技术文档

1. 安装指南

Punycode.js 可以通过 npm 进行安装：

npm install punycode --save

在 Node.js 环境中，请注意以下几点：

注意：用户模块不会隐藏核心模块。例如，require('punycode') 仍然会导入已经弃用的核心模块，即使你执行了 npm install punycode。 使用 require('punycode/') 来导入用户模块，而不是核心模块。

const punycode = require('punycode/');

2. 项目的使用说明

Punycode.js 是一个强大的 Punycode 转换器，完全遵循 RFC 3492 和 RFC 5891。以下是如何使用该项目的基本说明：

转换 Unicode 字符串到 Punycode 字符串

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

转换 Punycode 字符串到 Unicode 字符串

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

将 Punycode 编码的域名或电子邮件地址转换为 Unicode

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

punycode.toUnicode('джумла@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq'); // 'джумла@джpумлатест.bрфa'

将 Unicode 编码的域名或电子邮件地址转换为 Punycode

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

punycode.toASCII('джумла@джpумлатест.bрфa'); // 'джумла@xn--p-8sbkgc5ag7bhce.xn--ba-lmcq'

3. 项目API使用文档

以下是项目提供的 API 文档：

• punycode.decode(string): 将 Punycode 字符串的 ASCII 符号转换为 Unicode 符号字符串。
• punycode.encode(string): 将 Unicode 符号字符串转换为 Punycode 字符串的 ASCII 符号。
• punycode.toUnicode(input): 将 Punycode 字符串表示的域名或电子邮件地址转换为 Unicode。仅转换输入中的 Punycoded 部分。
• punycode.toASCII(input): 将小写的 Unicode 字符串表示的域名或电子邮件地址转换为 Punycode。仅转换输入中的非 ASCII 部分。
• punycode.ucs2.decode(string): 创建一个包含字符串中每个 Unicode 符号的数值代码点值的数组。
• punycode.ucs2.encode(codePoints): 创建一个基于数值代码点值数组的字符串。
• punycode.version: 表示当前 Punycode.js 版本号的字符串。

4. 项目安装方式

请参考安装指南部分，使用 npm 进行项目安装：

npm install punycode --save

然后在 Node.js 或现代浏览器环境中按照使用说明使用项目提供的 API。