nginstack

Class: Base64

@nginstack/engine/lib/encoding/Base64~ Base64

new Base64()

Classe que possibilita codificar e decodificar um dado na base 64.

Não devem ser construídas instâncias de Base64, e sim utilizar os métodos de classe.

Essa classe também é publicada no objeto global, mas seu uso é desencorajado.

Members

<static, constant> ARRAY_BUFFER_DECODING

Constante para ser usada no parâmetro decodeFmt do método decode. Indica que o método decode deve retornar um objeto ArrayBuffer.

<static, constant> MIME_ENCODING

Constante para ser usada no parâmetro encodeFmt do método encode. Indica que o método encode deve usar o formato base64 para MIME(RFC 2045), adicionando saltos de linha(CR+LF) a cada 76 caracteres.

<static, constant> STANDARD_ENCODING

Constante para ser usada no parâmetro encodeFmt do método encode. Indica que o método encode deve usar o formato base64(RFC 4648).

<static, constant> STRING_DECODING

Constante para ser usada no parâmetro decodeFmt do método decode. Indica que o método decode deve retornar uma String.

<static, constant> URL_ENCODING

Constante para ser usada no parâmetro encodeFmt do método encode. Indica que o método encode deve usar o formato base64url(RFC 4648), que substitui os caracteres '+' e '/' por '-' e '_'. Não são inclusos caracteres de padding no final da string.

Methods

<static> decode(str [, decodeFormat])

Decodifica uma string de base 64 para binário, sem quebra de linha.

Parameters:
Name Type Argument Description
str string | ArrayBuffer

String em base 64 a ser decodificada.
decodeFormat number <optional>

O formato de saída. Os valores possíveis são Base64.STRING_DECODING e Base64.ARRAY_BUFFER_DECODING.
Returns:

conteúdo de str decodificado de base 64.

Type
string | ArrayBuffer

<static> encode(bin [, encodeFormat])

Codifica um dado para a base 64.

Parameters:
Name Type Argument Description
bin string | ArrayBuffer | Uint8Array | MemoryStream | File

conteúdo a ser codificado. Os tipos MemoryStream e File não são suportados na codificação Base64.URL_ENCODING.
encodeFormat number <optional>

Informa a variação de codificação base 64 desejada. Os valores possíveis são Base64.URL_ENCODING, Base64.STANDARD_ENCODING e Base64.MIME_ENCODING, sendo este último o valor default. Se for informado um boolean (API antiga), é usado o Base64.MIME_ENCODING se verdadeiro e Base64.STANDARD_ENCODING se falso.
Returns:

String codificada em base 64.

Type
string