storage package

Armazenamento em nuvem para Firebase

Funções

Aulas

Enumerações

Interfaces

Variáveis

Aliases de tipo

função (aplicativo, ...)

getStorage(aplicativo, bucketUrl)

Obtém uma instância do FirebaseStorage para o aplicativo Firebase específico.

Assinatura:

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

Parâmetros

Retorna:

Armazenamento Firebase

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

Retorna:

vazio

ref(armazenamento, url)

Retorna um StorageReference para o URL fornecido.

Assinatura:

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

Parâmetros

Retorna:

Referência de armazenamento

função(ref, ...)

excluirObjeto(ref)

Exclui o objeto neste local.

Assinatura:

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

Parâmetros

Retorna:

Promessa<void>

Uma Promise que será resolvida se a exclusão for bem-sucedida.

getBlob(ref,maxDownloadSizeBytes)

Baixa os dados no local do objeto. Retorna um erro se o objeto não for encontrado.

Para usar essa funcionalidade, você precisa colocar a origem do seu aplicativo na lista de permissões no intervalo do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/configurando-cors

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

Assinatura:

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

Parâmetros

Retorna:

Promessa<Blob>

Uma promessa que resolve com um Blob contendo os bytes do objeto

getBytes(ref, maxDownloadSizeBytes)

Baixa os dados no local do objeto. Retorna um erro se o objeto não for encontrado.

Para usar essa funcionalidade, você precisa colocar a origem do seu aplicativo na lista de permissões no intervalo do Cloud Storage. Consulte também https://cloud.google.com/storage/docs/configurando-cors

Assinatura:

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

Parâmetros

Retorna:

Promessa<ArrayBuffer>

Uma promessa contendo os bytes do objeto

obterURL de download(ref)

Retorna o URL de download para o StorageReference fornecido .

Assinatura:

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

Parâmetros

Retorna:

Promessa<string>

Uma Promise que é resolvida com a URL de download deste objeto.

getMetadata(ref)

Uma Promise que é resolvida com os metadados deste objeto. Se este 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

Retorna:

Promessa< FullMetadata >

getStream(ref,maxDownloadSizeBytes)

Baixa os dados no local do objeto. Gera um evento de erro se o objeto não for encontrado.

Esta API está disponível apenas em Node.

Assinatura:

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

Parâmetros

Retorna:

NodeJS.ReadableStream

Um fluxo com os dados do objeto como bytes

lista(ref, opções)

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

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

GCS é um armazenamento de blobs de chaves. O Firebase Storage impõe a semântica da estrutura de pastas delimitada por '/'. Consulte a API List do GCS se quiser saber mais.

Para aderir à semântica das regras do Firebase, o Firebase Storage não oferece suporte a objetos cujos caminhos terminam com "/" ou contêm dois "/" consecutivos. A API Firebase Storage List filtrará esses objetos não suportados. list() poderá falhar se houver muitos objetos não suportados no bucket.

Assinatura:

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

Parâmetros

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 usado para obter o restante dos resultados.

listaTodos(ref)

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

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

Assinatura:

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

Parâmetros

Retorna:

Promessa< ListResult >

Uma Promise que resolve todos os itens e prefixos na 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, metadados)

Atualiza os metadados deste objeto.

Assinatura:

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

Parâmetros

Retorna:

Promessa< FullMetadata >

Uma Promise que é resolvida com os novos metadados para este objeto.

uploadBytes(ref, dados, metadados)

Carrega dados para o local deste objeto. O upload não pode ser retomado.

Assinatura:

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

Parâmetros

Retorna:

Promessa< UploadResult >

Uma promessa contendo um UploadResult

uploadBytesResumable(ref, dados, metadados)

Carrega dados para o local deste objeto. O upload pode ser pausado e retomado e expõe atualizações de progresso.

Assinatura:

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

Parâmetros

Retorna:

UploadTask

Uma tarefa de upload

uploadString(ref, valor, formato, metadados)

Carrega uma string no local deste objeto. O upload não pode ser retomado.

Assinatura:

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

Parâmetros

Retorna:

Promessa< UploadResult >

Uma promessa contendo um UploadResult

função(armazenamentoOrRef, ...)

ref(storageOrRef, caminho)

Retorna um StorageReference para o caminho fornecido no bucket padrão.

Assinatura:

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

Parâmetros

Retorna:

Referência de armazenamento

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 da Tarefa

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

Assinatura:

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

Código de erro de armazenamento

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

Assinatura:

export declare enum StorageErrorCode 

Membros de Enumeração