storage package

Almacenamiento en la nube para Firebase

Funciones

Clases

Enumeraciones

Interfaces

variables

Tipo de alias

función (aplicación, ...)

getStorage (aplicación, URL del depósito)

Obtiene una instancia de FirebaseStorage para la aplicación Firebase determinada.

Firma:

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

Parámetros

Devoluciones:

Almacenamiento de Firebase

Una instancia de FirebaseStorage .

función (almacenamiento, ...)

connectStorageEmulator(almacenamiento, host, puerto, opciones)

Modifique esta instancia de FirebaseStorage para comunicarse con el emulador de Cloud Storage.

Firma:

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

Parámetros

Devoluciones:

vacío

referencia (almacenamiento, URL)

Devuelve una StorageReference para la URL proporcionada.

Firma:

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

Parámetros

Devoluciones:

AlmacenamientoReferencia

función(referencia, ...)

eliminarObjeto(ref)

Elimina el objeto en esta ubicación.

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

Una Promise que se resuelve si la eliminación se realiza correctamente.

getBlob(ref, maxDownloadSizeBytes)

Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto.

Para utilizar esta funcionalidad, debe incluir el origen de su aplicación en la lista blanca en su depósito de Cloud Storage. Consulte también https://cloud.google.com/storage/docs/configuring-cors

Esta API no está disponible en Node.

Firma:

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

Parámetros

Devoluciones:

Promesa<Blob>

Una Promesa que se resuelve con un Blob que contiene los bytes del objeto.

getBytes(ref, maxDownloadSizeBytes)

Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto.

Para utilizar esta funcionalidad, debe incluir el origen de su aplicación en la lista blanca en su depósito de Cloud Storage. Consulte también https://cloud.google.com/storage/docs/configuring-cors

Firma:

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

Parámetros

Devoluciones:

Promesa<ArrayBuffer>

Una promesa que contiene los bytes del objeto.

obtener URL de descarga (ref)

Devuelve la URL de descarga para la StorageReference dada .

Firma:

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

Parámetros

Devoluciones:

Promesa<cadena>

Una Promise que se resuelve con la URL de descarga de este objeto.

obtenerMetadatos(ref)

Una Promise que se resuelve con los metadatos de este objeto. Si este objeto no existe o no se pueden recuperar los metadatos, la promesa se rechaza.

Firma:

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

Parámetros

Devoluciones:

Promesa< Metadatos completos >

getStream(ref, maxDownloadSizeBytes)

Descarga los datos en la ubicación del objeto. Genera un evento de error si no se encuentra el objeto.

Esta API solo está disponible en Node.

Firma:

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

Parámetros

Devoluciones:

NodeJS.ReadableStream

Una secuencia con los datos del objeto como bytes.

lista (referencia, opciones)

Enumere los elementos (archivos) y prefijos (carpetas) bajo esta referencia de almacenamiento.

La API de lista solo está disponible para Firebase Rules versión 2.

GCS es un almacén de blobs de claves. Firebase Storage impone la semántica de estructura de carpetas delimitadas por '/'. Consulte la API de lista de GCS si desea obtener más información.

Para cumplir con la semántica de las reglas de Firebase, Firebase Storage no admite objetos cuyas rutas terminen con "/" o contengan dos "/" consecutivas. La API Firebase Storage List filtrará estos objetos no compatibles. list() puede fallar si hay demasiados objetos no compatibles en el depósito.

Firma:

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

Parámetros

Devoluciones:

Promesa< ListResultado >

Una Promise que se resuelve con los elementos y prefijos. prefixes contienen referencias a subcarpetas y items contienen referencias a objetos en esta carpeta. nextPageToken se puede utilizar para obtener el resto de los resultados.

listaTodo(ref)

Enumere todos los elementos (archivos) y prefijos (carpetas) bajo esta referencia de almacenamiento.

Este es un método auxiliar para llamar a list() repetidamente hasta que no haya más resultados. El tamaño de paginación predeterminado es 1000.

Firma:

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

Parámetros

Devoluciones:

Promesa< ListResultado >

Una Promise que se resuelve con todos los elementos y prefijos bajo la referencia de almacenamiento actual. prefixes contienen referencias a subdirectorios y items contienen referencias a objetos en esta carpeta. nextPageToken nunca se devuelve.

actualizarMetadatos(ref, metadatos)

Actualiza los metadatos de este objeto.

Firma:

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

Parámetros

Devoluciones:

Promesa< Metadatos completos >

Una Promise que se resuelve con los nuevos metadatos de este objeto.

uploadBytes(ref, datos, metadatos)

Carga datos en la ubicación de este objeto. La carga no se puede reanudar.

Firma:

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

Parámetros

Devoluciones:

Promesa< SubirResultado >

Una promesa que contiene un UploadResult

uploadBytesResumable(ref, datos, metadatos)

Carga datos en la ubicación de este objeto. La carga se puede pausar y reanudar y expone actualizaciones de progreso.

Firma:

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

Parámetros

Devoluciones:

Cargar tarea

Una tarea de carga

uploadString(ref, valor, formato, metadatos)

Carga una cadena en la ubicación de este objeto. La carga no se puede reanudar.

Firma:

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

Parámetros

Devoluciones:

Promesa< SubirResultado >

Una promesa que contiene un UploadResult

función(almacenamientoOrRef, ...)

ref(almacenamientoORef, ruta)

Devuelve una StorageReference para la ruta dada en el depósito predeterminado.

Firma:

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

Parámetros

Devoluciones:

AlmacenamientoReferencia

Formato de cadena

Una enumeración de los posibles formatos de cadena para cargar.

Firma:

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

Formato de cadena

Una enumeración de los posibles formatos de cadena para cargar.

Firma:

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

Evento de tarea

Un evento que se desencadena en una tarea.

Firma:

export declare type TaskEvent = 'state_changed';

Estado de tarea

Representa el estado actual de una carga en ejecución.

Firma:

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

Código de error de almacenamiento

Códigos de error que se pueden adjuntar a objetos StorageError .

Firma:

export declare enum StorageErrorCode 

Miembros de enumeración