nginstack

Class: DownloadResult

@nginstack/engine/lib/cloud/ObjectStorage~ DownloadResult

new DownloadResult()

Representa o resultado da leitura de um objeto do repositório remoto.

Uma instância dessa classe é obtida através do método download da classe ObjectStorage. Com essa instância é possível inspecionar as informações do objeto armazenado no storage e utilizar um dos métodos "toFile", "toBytes" ou "toText" para consumir o conteúdo do objeto lido.

Members

cacheControl :string

Define a política de controle de cache do objeto.

Este parâmetro é relevante apenas nos casos em que os objetos forem acessíveis diretamente pelos navegadores.

Type:
  • string

contentDisposition :string

Especifica como o objeto deve ser manipulado por um navegador.

Este parâmetro é relevante apenas nos casos em que os objetos forem acessíveis diretamente pelos navegadores.

Type:
  • string

contentEncoding :string

Indica a codificação aplicada ao objeto.

Type:
  • string

contentType :string

Indica o tipo do conteúdo.

Type:
  • string

eTag :string

Identificador único atribuído ao objeto pelo repositório remoto.

Type:
  • string

lastModified :Date

Data da ultima atualização.

Type:
  • Date

location :string

Caminho do objeto no repositório remoto.

Type:
  • string

metadata :Record.<string, string>

Conjunto de pares chave/valor que foram atribuídos ao objeto.

Type:
  • Record.<string, string>

size :number

Tamanho do objeto em bytes.

Type:
  • number

version :string

Indicador de versão do objeto.

Type:
  • string

Methods

toBytes( [options])

Retorna o conteúdo do objeto baixado do repositório remoto no formato de bytes.

Por questão de performance e consumo de memória, a chamada desse método deve ser feita uma única vez. Após ler os bytes da resposta, novas execuções deste método retornam um erro informando que o conteúdo já foi consumido.

O uso deste método é limitado a objetos de tamanho máximo de 16MiB. Para objetos maiores deve ser utilizado o método toFile.

Parameters:
Name Type Argument Description
options Object <optional>

Opções de leitura do conteúdo do objeto.

Properties
Name Type Argument Description
resultType string <optional>

O tipo do resultado gerado por esta função. Os valores possíveis são "uint8array", "arraybuffer" ou "binaryString". Caso não seja informado, será retornado no formato Uint8Array.
Returns:

Bytes do objeto. Se não for encontrado um objeto no caminho informado será gerado erro.

Type
Uint8Array | ArrayBuffer

toFile(destination)

Grava o conteúdo do objeto no arquivo informado. Se uma ou mais pastas no caminho do arquivo não existirem elas serão criadas. Se a gravação for bem sucedida esse método não retorna nada. Caso não consiga realizar a gravação um erro será gerado.

Parameters:
Name Type Description
destination string

Caminho do arquivo onde os bytes do objeto devem ser escritos.

toText()

Retorna o conteúdo do objeto baixado do repositório remoto no formato de texto.

O uso deste método é limitado a objetos de tamanho máximo de 16MiB. Para objetos maiores deve ser utilizado o método toFile.

Returns:

Conteúdo do objeto no formato de texto.

Type
string