Punycode¶

v18.x.x

Версия модуля punycode, входящего в состав Node.js, устаревает. В будущей основной версии Node.js этот модуль будет удален. Пользователи, в настоящее время зависящие от модуля punycode, должны перейти на использование модуля Punycode.js, предоставляемого userland. Для кодирования URL на основе punycode смотрите url.domainToASCII или, в более общем случае, WHATWG URL API.

Модуль punycode - это собранная версия модуля Punycode.js. Доступ к нему можно получить, используя:

1

const punycode = require('punycode');

Punycode - это схема кодирования символов, определенная RFC 3492, которая в первую очередь предназначена для использования в интернационализированных доменных именах. Поскольку имена хостов в URL ограничены только символами ASCII, доменные имена, содержащие символы, не являющиеся символами ASCII, должны быть преобразованы в ASCII с помощью схемы Punycode. Например, японский иероглиф, которым переводится английское слово 'example', - это '例'. Интернационализированное доменное имя '例.com' (эквивалентное 'example.com') представлено в Punycode как строка ASCII 'xn--fsq.com'.

Модуль punycode обеспечивает простую реализацию стандарта Punycode.

Модуль punycode является сторонней зависимостью, используемой Node.js и предоставляемой разработчикам для удобства. Исправления или другие модификации модуля должны быть направлены в проект Punycode.js.

punycode.decode(string)¶

• string <string>

Метод punycode.decode() преобразует строку Punycode из символов только ASCII в эквивалентную строку кодовых точек Unicode.

1
2

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

punycode.encode(string)¶

• string <string>

Метод punycode.encode() преобразует строку кодовых точек Unicode в Punycode строку символов только ASCII.

1
2

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

punycode.toASCII(domain)¶

• domain <string>

Метод punycode.toASCII() преобразует строку Unicode, представляющую интернационализированное доменное имя, в Punycode. Преобразуются только части доменного имени, не относящиеся к коду ASCII. Вызов punycode.toASCII() для строки, которая уже содержит только символы ASCII, не будет иметь никакого эффекта.

1
2
3
4

// кодирование доменных имен
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, в Юникод. Преобразуются только части доменного имени, закодированные Punycode.

1
2
3
4

// декодирование доменных имен
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 в строке.

1
2
3

punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]
// суррогатная пара для тетраграммы U+1D306 для центра:
punycode.ucs2.decode('\uD834\uDF06'); // [0x1D306]

punycode.ucs2.encode(codePoints)¶

• codePoints <integer[]>

Метод punycode.ucs2.encode() возвращает строку, основанную на массиве числовых значений кодовых точек.

1
2

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

punycode.version¶

• <string>

Возвращает строку, определяющую номер текущей версии Punycode.js.