storage package

Cloud Storage para Firebase

Funções

Função Descrição
function(app, ...) (link em inglês)
getStorage(app, bucketUrl) Recebe uma instância FirebaseStorage para o app do Firebase especificado.
function(storage, ...)
connectStorageEmulator(armazenamento, host, porta, opções) Modifique esta instância do FirebaseStorage para se comunicar com o emulador do Cloud Storage.
ref(storage, url) Retorna uma StorageReference para o URL fornecido.
function(ref, ...)
deleteObject(ref) (em inglês) Exclui o objeto neste local.
getBlob(ref, maxDownloadSizeBytes) Faz o download dos dados no local do objeto. Retornará um erro se o objeto não for encontrado.Para usar essa funcionalidade, você precisa autorizar a origem do seu app no bucket do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/creating-corsEssa API não está disponível no Node.
getBytes(ref, maxDownloadSizeBytes) Faz o download dos dados no local do objeto. Retornará um erro se o objeto não for encontrado.Para usar essa funcionalidade, você precisa autorizar a origem do seu app no bucket do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/setting-cors
getDownloadURL(ref) Retorna o URL de download para a StorageReference especificada.
getMetadata(ref) (em inglês) Um Promise que é resolvido com os metadados desse objeto. Se o objeto não existir ou os metadados não puderem ser recuperados, a promessa será rejeitada.
getStream(ref, maxDownloadSizeBytes) Faz o download dos dados no local do objeto. Um evento de erro será gerado se o objeto não for encontrado.Essa API só está disponível no Node.
list(ref, options) Liste itens (arquivos) e prefixos (pastas) nesta referência de armazenamento.A API List está disponível apenas para a versão 2 das regras do Firebase.O GCS é um armazenamento de chaves de blobs. O Firebase Storage impõe a semântica de "/" de pastas delimitadas. Consulte a API List do GCS para saber mais.Para seguir a semântica das regras do Firebase, o Firebase Storage não é compatível com objetos com caminhos que terminam com "/" ou conter dois "/"s consecutivos. A API Firebase Storage List vai filtrar esses objetos incompatíveis. list() poderá falhar se houver muitos objetos sem suporte no bucket.
listAll(ref) Liste todos os itens (arquivos) e prefixos (pastas) nesta referência de armazenamento.Esse é um método auxiliar para chamar list() repetidamente até que não haja mais resultados. O tamanho de paginação padrão é 1.000.Observação: os resultados podem não ser consistentes se os objetos forem alterados enquanto essa operação estiver em execução.Aviso: listAll pode consumir muitos recursos se houver muitos resultados.
updateMetadata(ref, metadata) Atualiza os metadados deste objeto.
uploadBytes(ref, dados, metadados) Faz upload dos dados para o local deste objeto. O upload não será retomável.
uploadBytesResumable(ref, dados, metadados) Faz upload dos dados para o local deste objeto. O upload pode ser pausado e retomado, além de expor atualizações de progresso.
uploadString(ref, value, format, metadata) Faz upload de uma string no local deste objeto. O upload não será retomável.
function(storageOrRef, ...)
ref(storageOrRef, path) Retorna uma StorageReference para o caminho especificado no bucket padrão.

Classes

Turma Descrição
StorageError (link em inglês) Um erro retornado pelo SDK do Firebase Storage.

Enumerações

Enumeração Descrição
StorageErrorCode (em inglês) Códigos de erro que podem ser anexados a objetos StorageError.

Interfaces

Interface Descrição
FirebaseStorage Uma instância do Firebase Storage.
FullMetadata (em inglês) O conjunto completo de metadados do objeto, incluindo propriedades somente leitura.
ListOptions (em inglês) As opções aceitas pelo list().
ListResult (em inglês) Resultado retornado por list().
SettableMetadata (em inglês) Metadados de objeto que podem ser definidos a qualquer momento.
StorageObserver (link em inglês) Um observador de stream para o Firebase Storage.
StorageReference (link em inglês) Representa uma referência a um objeto do Google Cloud Storage. Os desenvolvedores podem fazer upload, download e excluir objetos, bem como obter/definir metadados de objetos.
UploadMetadata (em inglês) Metadados de objeto que podem ser definidos no upload.
UploadResult (em inglês) Resultado retornado de um upload não retomável.
UploadTask (link em inglês) Representa o processo de upload de um objeto. Permite monitorar e gerenciar o upload.
UploadTaskSnapshot. Mantém dados sobre o estado atual da tarefa de upload.

Variáveis

Variável Descrição
StringFormat (link em inglês) Uma enumeração dos possíveis formatos de string para upload.

Aliases de tipos

Alias de tipo Descrição
StringFormat (link em inglês) Uma enumeração dos possíveis formatos de string para upload.
TaskEvent (link em inglês) Um evento que é acionado em uma tarefa.
TaskState (link em inglês) Representa o estado atual de um upload em execução.

função(app, ...)

getStorage(app, bucketUrl)

Recebe uma instância FirebaseStorage para o app do Firebase especificado.

Assinatura:

export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;

Parâmetros

Parâmetro Tipo Descrição
app FirebaseApp App do Firebase para o qual receber a instância do FirebaseStorage.
bucketUrl string O URL gs:// para seu bucket do Firebase Storage. Se não for transmitido, o bucket do Storage é usado.

Retorna:

FirebaseStorage

Uma instância do FirebaseStorage.

função(armazenamento, ...)

connectStorageEmulator(armazenamento; host; porta; opções)

Modifique esta instância do FirebaseStorage para se comunicar com o emulador do Cloud Storage.

Assinatura:

export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parâmetros

Parâmetro Tipo Descrição
storage FirebaseStorage a instância FirebaseStorage
host string O host do emulador (por exemplo: localhost)
porta number A porta do emulador (por exemplo: 5001)
options { mockUserToken? EmulatorMockTokenOptions | string } Opções do emulador. options.mockUserToken é o token de autenticação simulado para ser usado no teste de unidade das regras de segurança.

Retorna:

void

ref(armazenamento, url)

Retorna uma StorageReference para o URL fornecido.

Assinatura:

export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;

Parâmetros

Parâmetro Tipo Descrição
storage FirebaseStorage FirebaseStorage.
url string URL. Se estiver vazio, retorna a referência de raiz.

Retorna:

StorageReference (link em inglês)

function(ref, ...)

deleteObject(ref)

Exclui o objeto neste local.

Assinatura:

export declare function deleteObject(ref: StorageReference): Promise<void>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference do objeto a ser excluído.

Retorna:

Promessa<void>

Uma Promise que resolve se a exclusão é bem-sucedida.

getBlob(ref, maxDownloadSizeBytes)

Faz o download dos dados no local do objeto. Retornará um erro se o objeto não for encontrado.

Para usar essa funcionalidade, você precisa autorizar a origem do seu app no bucket do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/setting-cors

Esta API não está disponível no Node.

Assinatura:

export declare function getBlob(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<Blob>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference, em que é feito o download dos dados.
maxDownloadSizeBytes number Se definido, o tamanho máximo permitido em bytes a serem recuperados.

Retorna:

Promessa<Blob>

Uma promessa que se resolve com um blob contendo os bytes do objeto

getBytes(ref, maxDownloadSizeBytes)

Faz o download dos dados no local do objeto. Retornará um erro se o objeto não for encontrado.

Para usar essa funcionalidade, você precisa autorizar a origem do seu app no bucket do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/setting-cors

Assinatura:

export declare function getBytes(ref: StorageReference, maxDownloadSizeBytes?: number): Promise<ArrayBuffer>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference, em que é feito o download dos dados.
maxDownloadSizeBytes number Se definido, o tamanho máximo permitido em bytes a serem recuperados.

Retorna:

Promessa<ArrayBuffer>

uma promessa contendo os bytes do objeto

getDownloadURL(ref)

Retorna o URL de download para a StorageReference especificada.

Assinatura:

export declare function getDownloadURL(ref: StorageReference): Promise<string>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference para conseguir o URL de download.

Retorna:

Promessa<string>

Uma Promise que é resolvida com o URL de download desse objeto.

getMetadata(ref)

Um Promise que é resolvido com os metadados desse objeto. Se o objeto não existir ou os metadados não puderem ser recuperados, a promessa será rejeitada.

Assinatura:

export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference usada para receber metadados.

Retorna:

Promessa<FullMetadata>

getStream(ref, maxDownloadSizeBytes)

Faz o download dos dados no local do objeto. Um evento de erro será gerado se o objeto não for encontrado.

Essa API só está disponível em Node.

Assinatura:

export declare function getStream(ref: StorageReference, maxDownloadSizeBytes?: number): ReadableStream;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference, em que é feito o download dos dados.
maxDownloadSizeBytes number Se definido, o tamanho máximo permitido em bytes a serem recuperados.

Retorna:

ReadableStream

Um stream com os dados do objeto como bytes

list(ref, options)

Liste itens (arquivos) e prefixos (pastas) nesta referência de armazenamento.

A API List está disponível apenas para a segunda versão das regras do Firebase.

O GCS é um repositório de blobs de chave. O Firebase Storage impõe a semântica de "/" de pastas delimitadas. Consulte a API List do GCS se quiser saber mais.

Para seguir a semântica das regras do Firebase, o Firebase Storage não oferece suporte a objetos com caminhos que terminam com "/" ou conter dois "/"s consecutivos. A API Firebase Storage List vai filtrar esses objetos incompatíveis. list() poderá falhar se houver muitos objetos sem suporte no bucket.

Assinatura:

export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference usada para receber a lista.
options ListOptions (em inglês) Consulte ListOptions para ver detalhes.

Retorna:

Promessa<ListResult>

Uma Promise que se resolve com os itens e prefixos. prefixes contém referências a subpastas e items contém referências a objetos nesta pasta. nextPageToken pode ser usada para conferir o restante dos resultados.

listAll(ref)

Liste todos os itens (arquivos) e prefixos (pastas) nesta referência de armazenamento.

Esse é um método auxiliar para chamar list() repetidamente até que não haja mais resultados. O tamanho de paginação padrão é 1.000.

Assinatura:

export declare function listAll(ref: StorageReference): Promise<ListResult>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference usada para receber a lista.

Retorna:

Promessa<ListResult>

Uma Promise que é resolvida com todos os itens e prefixos de acordo com a referência de armazenamento atual. prefixes contém referências a subdiretórios e items contém referências a objetos nesta pasta. nextPageToken nunca é retornado.

updateMetadata(ref, metadata)

Atualiza os metadados deste objeto.

Assinatura:

export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference para atualização dos metadados.
metadados SettableMetadata (em inglês) Os novos metadados para o objeto. Somente os valores que foram explicitamente definidos serão alterados. Definir explicitamente um valor como nulo removerá os metadados.

Retorna:

Promessa<FullMetadata>

Um Promise que é resolvido com os novos metadados para esse objeto.

uploadBytes(ref, dados, metadados)

Faz upload dos dados para o local deste objeto. O upload não será retomável.

Assinatura:

export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference em que é feito o upload dos dados.
dados Bolha | Uint8Array | Buffer de matriz Os dados a serem enviados.
metadados UploadMetadata (em inglês) Metadados dos dados a serem enviados.

Retorna:

Promessa<UploadResult>

Uma promessa contendo um UploadResult

uploadBytesResumable(ref, dados, metadados)

Faz upload dos dados para o local deste objeto. O upload pode ser pausado e retomado, além de expor atualizações de progresso.

Assinatura:

export declare function uploadBytesResumable(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): UploadTask;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference em que é feito o upload dos dados.
dados Bolha | Uint8Array | Buffer de matriz Os dados a serem enviados.
metadados UploadMetadata (em inglês) Metadados dos dados a serem enviados.

Retorna:

UploadTask (link em inglês)

Uma UploadTask

uploadString(ref; valor; formato; metadados)

Faz upload de uma string no local deste objeto. O upload não será retomável.

Assinatura:

export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;

Parâmetros

Parâmetro Tipo Descrição
ref StorageReference (link em inglês) StorageReference em que a string precisa ser carregada.
valor string A string a ser enviada.
formato StringFormat (link em inglês) O formato da string a ser enviada.
metadados UploadMetadata (em inglês) Metadados da string a ser enviada.

Retorna:

Promessa<UploadResult>

Uma promessa contendo um UploadResult

function(storageOrRef, ...)

ref(storageOrRef, path)

Retorna uma StorageReference para o caminho especificado no bucket padrão.

Assinatura:

export declare function ref(storageOrRef: FirebaseStorage | StorageReference, path?: string): StorageReference;

Parâmetros

Parâmetro Tipo Descrição
storageOrRef FirebaseStorage | StorageReference (em inglês) FirebaseStorage ou StorageReference.
path string

Retorna:

StorageReference (link em inglês)

StringFormat

Uma enumeração dos possíveis formatos de string para upload.

Assinatura:

StringFormat: {
    readonly RAW: "raw";
    readonly BASE64: "base64";
    readonly BASE64URL: "base64url";
    readonly DATA_URL: "data_url";
}

StringFormat

Uma enumeração dos possíveis formatos de string para upload.

Assinatura:

export declare type StringFormat = (typeof StringFormat)[keyof typeof StringFormat];

Evento de tarefa

Um evento que é acionado em uma tarefa.

Assinatura:

export declare type TaskEvent = 'state_changed';

Estado-tarefa

Representa o estado atual de um upload em execução.

Assinatura:

export declare type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';

StorageErrorCode

Códigos de erro que podem ser anexados a objetos StorageError.

Assinatura:

export declare enum StorageErrorCode

Membros de enumeração

Participante Valor Descrição
APP_EXCLUÍDO "app-deleted"
BUCKET_NOT_FOUND "bucket-not-found"
CANCELADO "canceled"
NÃO É POSSÍVEL_SLICE_BLOB "cannot-slice-blob"
INTERNAL_ERROR "internal-error"
INVALID_ARGUMENT "invalid-argument"
INVALID_MCC_COUNT "invalid-argument-count"
INVALID_CHECKSUM "invalid-checksum"
INVALID_DEFAULT_BUCKET "invalid-default-bucket"
INVALID_EVENT_NAME "invalid-event-name"
INVALID_FORMAT "invalid-format"
OPERAÇÃO_DA_ROOT_INVÁLIDA "invalid-root-operation"
URL_INVÁLIDA "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
SEM_DOWNLOAD_URL "no-download-url"
OBJETO_NÃO_ENCONTRADO "object-not-found"
PROJETO_NÃO_ENCONTRADO "project-not-found"
COTA_EXCEDIDA "quota-exceeded"
LIMITE_DE_EXCEDIDO_NOVAMENTE "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
UNAUTHENTICATED "unauthenticated"
UNAUTHORIZED "unauthorized"
APP NÃO AUTORIZADO "unauthorized-app"
DESCONHECIDO "unknown"
AMBIENTE_INCOMPATÍVEL "unsupported-environment"