storage package

Cloud Storage para Firebase

Funções

Classes

Enumerações

Interfaces

Variáveis

Aliases de tipos

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

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

Retorna:

void

ref(armazenamento, url)

Retorna uma StorageReference para o URL fornecido.

Assinatura:

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

Parâmetros

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

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

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

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

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

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

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

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

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

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

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

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

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

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