nginstack

Class: TextDecoder

TextDecoder

new TextDecoder( [utfLabel] [, options])

Classe que transforma uma sequência de bytes, em uma determinada codificação, em texto.

Mais detalhes em MDN TextDecoder.

Parameters:
Name Type Argument Description
utfLabel string <optional>

Rótulo da codificação esperada pelo método decode. São suportadas as seguintes codificações: 'utf-8', 'windows-1252' e 'iso-8859-1', essa última sendo um nome alternativo para 'windows-1252'. O valor padrão é 'utf-8'.
options Object <optional>

Opções de decodificação.

Properties
Name Type Argument Default Description
fatal boolean <optional>
 false

Indica se o método decode deve lançar um erro quando a sequência de bytes não for válida na codificação. Caso seja falso, as sequências inválidas serão substituídas pelo caractere U+FFFD.
ignoreBOM boolean <optional>
 false

Indica se a marca de ordem de bytes (BOM) da codificação deve ser mantida no texto decodificado. Por padrão, ela é removida.
See:
Example
const decoder = new TextDecoder('utf-8', { fatal: true });
decoder.decode(new Uint8Array([97, 195, 167, 97, 195, 173])); // => 'açaí'
decoder.decode(new Uint8Array([97, 231, 97])); // => lança um erro

Members

encoding :string

Codificação que será aplicada por este objeto.

Type:
  • string

fatal :boolean

Indica se o método decode lança um erro quando a sequência de bytes não é válida na codificação.

Type:
  • boolean

ignoreBOM :boolean

Indica se a marca de ordem de bytes (BOM) é mantida no texto decodificado.

Type:
  • boolean

Methods

decode( [buffer] [, options])

Decodifica uma sequência de bytes em um texto.

Parameters:
Name Type Argument Description
buffer Uint8Array | ArrayBuffer <optional>

Sequência de bytes a ser decodificada. Caso não seja informada, será retornado um texto vazio.
options Object <optional>

Opções da decodificação. A opção stream da especificação não é suportada.
Throws:

Caso a opção fatal tenha sido informada na criação do objeto e a sequência de bytes não seja válida na codificação.

Type
Error
Returns:

Texto decodificado a partir da sequência de bytes.

Type
string