Punycode

Obsoleto desde: v7.0.0

[Estável: 0 - Obsoleto]

Estável: 0 Estabilidade: 0 - Obsoleto

Código Fonte: lib/punycode.js

A versão do módulo punycode incluída no Node.js está obsoleta. Em uma versão principal futura do Node.js, este módulo será removido. Os usuários que dependem atualmente do módulo punycode devem mudar para usar o módulo Punycode.js fornecido pelo usuário. Para codificação de URL baseada em punycode, consulte url.domainToASCII ou, mais geralmente, a API de URL WHATWG.

O módulo punycode é uma versão incluída do módulo Punycode.js. Ele pode ser acessado usando:

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

Punycode é um esquema de codificação de caracteres definido pela RFC 3492, que se destina principalmente ao uso em Nomes de Domínio Internacionalizados. Como os nomes de host em URLs são limitados apenas a caracteres ASCII, os Nomes de Domínio que contêm caracteres não ASCII devem ser convertidos em ASCII usando o esquema Punycode. Por exemplo, o caractere japonês que se traduz na palavra inglesa, 'example' é '例'. O Nome de Domínio Internacionalizado, '例.com' (equivalente a 'example.com') é representado por Punycode como a string ASCII 'xn--fsq.com'.

O módulo punycode fornece uma implementação simples do padrão Punycode.

O módulo punycode é uma dependência de terceiros usada pelo Node.js e disponibilizada aos desenvolvedores por conveniência. Correções ou outras modificações no módulo devem ser direcionadas ao projeto Punycode.js.

punycode.decode(string)

Adicionado em: v0.5.1

• string <string>

O método punycode.decode() converte uma string Punycode de caracteres somente ASCII para a string equivalente de codepoints Unicode.

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

punycode.encode(string)

Adicionado em: v0.5.1

• string <string>

O método punycode.encode() converte uma string de codepoints Unicode em uma string Punycode de caracteres somente ASCII.

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

punycode.toASCII(domain)

Adicionado em: v0.6.1

• domain <string>

O método punycode.toASCII() converte uma string Unicode representando um Nome de Domínio Internacionalizado em Punycode. Apenas as partes não ASCII do nome de domínio serão convertidas. Chamar punycode.toASCII() em uma string que já contenha apenas caracteres ASCII não terá efeito.

// codificar nomes de domínio
punycode.toASCII('mañana.com');  // 'xn--maana-pta.com'
punycode.toASCII('☃-⌘.com');   // 'xn----dqo34k.com'
punycode.toASCII('example.com'); // 'example.com'

punycode.toUnicode(domain)

Adicionado em: v0.6.1

• domain <string>

O método punycode.toUnicode() converte uma string representando um nome de domínio contendo caracteres codificados em Punycode em Unicode. Apenas as partes do nome de domínio codificadas em Punycode serão convertidas.

// decodificar nomes de domínio
punycode.toUnicode('xn--maana-pta.com'); // 'mañana.com'
punycode.toUnicode('xn----dqo34k.com');  // '☃-⌘.com'
punycode.toUnicode('example.com');       // 'example.com'

punycode.ucs2

Adicionado em: v0.7.0

punycode.ucs2.decode(string)

Adicionado em: v0.7.0

• string <string>

O método punycode.ucs2.decode() retorna um array contendo os valores numéricos do codepoint de cada símbolo Unicode na string.

punycode.ucs2.decode('abc'); // [0x61, 0x62, 0x63]
// par substituto para U+1D306 tetragrama para centro:
punycode.ucs2.decode('\uD834\uDF06'); // [0x1D306]

punycode.ucs2.encode(codePoints)

Adicionado em: v0.7.0

• codePoints <integer[]>

O método punycode.ucs2.encode() retorna uma string baseada em um array de valores numéricos de ponto de código.

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

punycode.version

Adicionado em: v0.6.1

• <string>

Retorna uma string identificando o número da versão atual do Punycode.js.