Punycode

Версия модуля punycode, включённого в Node.js, устаревает. В будущей основной версии Node.js этот модуль будет удалён. Пользователям, в настоящее время зависящим от модуля punycode, следует переключиться на использование модуля Punycode.js, предоставляемого пользователем, здесь.

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

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 <строка>

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

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

punycode.encode(string)

• string <строка>

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

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

punycode.toASCII(domain)

• domain <строка>

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

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

• domain <строка>

Метод punycode.toUnicode() преобразует строку, представляющую имя домена, содержащее закодированные в Punycode символы, в Юникод. Будут преобразованы только закодированные в 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)

• string <строка>

Метод punycode.ucs2.decode() возвращает массив, содержащий числовые значения кодовых точек каждого символа Юникода в строке.

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)

• codePoints <массив целых чисел>

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

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

punycode.version

• <строка>

Возвращает строку, идентифицирующую текущую версию Punycode.js.