nginstack

Class: Encoder

@nginstack/engine/lib/encoding/Encoder~ Encoder

new Encoder()

Esta classe prove métodos para a conversão entre diferentes sistemas de codificação de texto. O nome da codificação deve estar de acordo com o padrão definido em: http://www.iana.org/assignments/character-sets.
Atualmente são suportados as codificações ISO-8859-1, UTF-8 e WINDOWS-1252.

Esta classe também é publicada como Encoder no escopo global.

Examples
const Encoder = require('@nginstack/engine/lib/encoding/Encoder');
// Convertendo uma string em ISO-8859-1 para UTF-8:
const nome = Encoder.convertFromString(Encoder.UTF_8, 'João');
// ou:
const nome = Encoder.convert(Encoder.ISO_8859_1, Encoder.UTF_8, 'João');
// A variável "nome" conterá o valor "João".
const Encoder = require('@nginstack/engine/lib/encoding/Encoder');
// Convertendo uma string em UTF-8 para ISO-8859-1:
const nome = Encoder.convertToString(Encoder.UTF_8, 'João');
// ou:
const nome = Encoder.convert(Encoder.UTF_8, Encoder.ISO_8859_1, 'João');
// A variável "nome" conterá o valor "João".

Members

<static> ARRAY_BUFFER_FORMAT :string

Constante para ser usada nos métodos convertFromString e convert. Indica que o método deve retornar um ArrayBuffer.

Type:
  • string

<static> ISO_8859_1 :string

Constante para a codificação em ISO-8859-1 também conhecida como Latin1.

Type:
  • string
See:

<static> STRING_FORMAT :string

Constante para ser usada nos métodos convertFromString e convert. Indica que o método deve retornar uma String.

Type:
  • string

<static> UTF_8 :string

Constante para a codificação em UTF-8.

Type:
  • string
See:

<static> WINDOWS_1252 :string

Constante para a codificação em WINDOWS-1252, padrão adotado pelo iJavaScript.

Type:
  • string
See:

Methods

<static> convert(sourceEncoding, targetEncoding, source [, encodeFmt])

Método de classe que converte a string da codificação de origem para a codificação de destino.

Parameters:
Name Type Argument Description
sourceEncoding string

Codificação da string de origem.
targetEncoding string

Codificação da string de destino.
source string | ArrayBuffer

String ou sequência de bytes a ser convertida.
encodeFmt string <optional>

O formato de saída. Os valores possíveis são Encoder.STRING_FORMAT e Encoder.ARRAY_BUFFER_FORMAT.
See:
Returns:

String ou ArrayBuffer na codificação especificada.

Type
string | ArrayBuffer

<static> convertFromString(targetEncoding, source [, encodeFmt])

Método de classe que converte a string da codificação utilizada no iJavascript (WINDOWS-1252) para a codificação especificada.

Parameters:
Name Type Argument Description
targetEncoding string

Codificação da string de saída.
source string

String a ser convertida.
encodeFmt string <optional>

O formato de saída. Os valores possíveis são Encoder.STRING_FORMAT e Encoder.ARRAY_BUFFER_FORMAT.
See:
Returns:

String ou ArrayBuffer na codificação especificada.

Type
string | ArrayBuffer

<static> convertToString(sourceEncoding, source)

Método de classe que converte a string da codificação de origem para a codificação utilizada no iJavascript (WINDOWS-1252).

Parameters:
Name Type Description
sourceEncoding string

Codificação da string de origem.
source string | ArrayBuffer

String ou sequência de bytes a ser convertida.
See:
Returns:

String codificada em WINDOWS-1252.

Type
string

<static> listEncodings()

Método de classe que lista as codificações suportadas de acordo com o padrão especificado em: http://www.iana.org/assignments/character-sets.

Returns:

Array com os nomes das codificações suportadas.

Type
Array

<static> supports(encodingName)

Método de classe que verifica se a codificação especificada é suportada.

Parameters:
Name Type Description
encodingName string

Nome da codificação de acordo com o padrão especificado em: http://www.iana.org/assignments/character-sets.
Returns:

String na codificação especificada.

Type
boolean