storage package

Cloud Storage para Firebase

Funciones

Función Descripción
function(app, ...)
getStorage(app, bucketUrl) Obtiene una instancia de FirebaseStorage para la app de Firebase determinada.
function(storage, ...)
connectStorageEmulator(almacenamiento, host, puerto, opciones) Modifica esta instancia de FirebaseStorage para que se comunique con el emulador de Cloud Storage.
ref(almacenamiento, url) Muestra una StorageReference para la URL determinada.
function(ref, ...)
deleteObject(ref) Borra el objeto en esta ubicación.
getBlob(ref, maxDownloadSizeBytes) Descarga los datos en la ubicación del objeto. Muestra un error si no se encuentra el objeto.Para usar esta funcionalidad, debes incluir en la lista blanca el origen de tu app en el bucket de Cloud Storage. Consulta también https://cloud.google.com/storage/docs/configuration-corsEsta API no se encuentra disponible en Node.
getBytes(ref, maxDownloadSizeBytes) Descarga los datos en la ubicación del objeto. Muestra un error si no se encuentra el objeto.Para usar esta funcionalidad, debes incluir en la lista blanca el origen de tu app en el bucket de Cloud Storage. Consulta también https://cloud.google.com/storage/docs/configuration-cors
getDownloadURL(ref) Muestra la URL de descarga de la StorageReference determinada.
getMetadata(ref) Una Promise que se resuelve con los metadatos de este objeto. Si este objeto no existe o los metadatos no se pueden recuperar, se rechaza la promesa.
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.
list(ref, opciones) Indica los elementos (archivos) y los prefijos (carpetas) en esta referencia de almacenamiento.La API de List solo está disponible para la versión 2 de las reglas de Firebase.GCS es un almacén de BLOB de claves. Firebase Storage impone la semántica de “/”. de carpetas delimitadas. Consulta la API de List de GCS si quieres 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 contener dos “/” consecutivas. La API de Firebase Storage List filtrará estos objetos no admitidos. list() puede fallar si hay demasiados objetos incompatibles en el bucket.
listAll(ref) Enumera todos los elementos (archivos) y los prefijos (carpetas) de esta referencia de almacenamiento.Este es un método de ayuda para llamar a list() varias veces hasta que no haya más resultados. El tamaño de paginación predeterminado es 1,000.Nota: Es posible que los resultados no sean coherentes si se cambian los objetos mientras se ejecuta esta operación.Advertencia: Es posible que listAll consuma demasiados recursos si hay demasiados resultados.
updateMetadata(ref, metadata) Actualiza los metadatos de este objeto.
uploadBytes(ref, datos, metadatos) Sube datos a la ubicación de este objeto. No se puede reanudar la carga.
uploadBytesResumable(ref, datos, metadatos) Sube datos a la ubicación de este objeto. La carga se puede pausar y reanudar, y expone las actualizaciones de progreso.
uploadString(ref, valor, formato, metadatos) Sube una cadena a la ubicación de este objeto. No se puede reanudar la carga.
function(storageOrRef, ...)
ref(storageOrRef, ruta) Muestra una StorageReference para la ruta de acceso determinada en el bucket predeterminado.

Clases

Clase Descripción
Error de almacenamiento Un error que muestra el SDK de Firebase Storage.

Enumeraciones

Enumeration Descripción
StorageErrorCode. Códigos de error que se pueden adjuntar a objetos StorageError.

Interfaces

Interfaz Descripción
FirebaseStorage Una instancia de Firebase Storage.
FullMetadata El conjunto completo de metadatos de objetos, incluidas las propiedades de solo lectura.
Opciones de lista Las opciones que acepta list()
ListResult Resultado que devuelve list().
SettableMetadata Metadatos de objeto que se pueden configurar en cualquier momento.
StorageObserver. Un observador de transmisiones para Firebase Storage.
Referencia de Storage Representa una referencia a un objeto de Google Cloud Storage. Los desarrolladores pueden subir, descargar y borrar objetos, así como obtener y establecer metadatos de objetos.
UploadMetadata Metadatos del objeto que se pueden configurar durante la carga
UploadResult. Resultado que se muestra en una carga no reanudable.
UploadTask Representa el proceso de carga de un objeto. Te permite supervisar y administrar la carga.
UploadTaskSnapshot. Contiene datos sobre el estado actual de la tarea de carga.

Variables

Variable Descripción
StringFormat Una enumeración de los posibles formatos de cadena para la carga.

Escribe alias

Alias de tipo Descripción
StringFormat Una enumeración de los posibles formatos de cadena para la carga.
TaskEvent. Un evento que se activa en una tarea.
TaskState Representa el estado actual de una carga en ejecución.

función(app, ...)

getStorage(app, bucketUrl)

Obtiene una instancia de FirebaseStorage para la app de Firebase determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
app App de Firebase App de Firebase para la que quieres obtener la instancia de FirebaseStorage.
URL del bucket string La URL gs:// a tu bucket de Firebase Storage. Si no se pasa, se usa el bucket de Storage predeterminado de la app.

Muestra:

FirebaseStorage

Una instancia de FirebaseStorage.

función(almacenamiento, ...)

connectStorageEmulator(almacenamiento, host, puerto, opciones)

Modifica esta instancia de FirebaseStorage para que se comunique con el emulador de Cloud Storage.

Firma:

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

Parámetros

Parámetro Tipo Descripción
almacenamiento FirebaseStorage La instancia FirebaseStorage
host string El host del emulador (p. ej., localhost)
puerto número El puerto del emulador (p. ej., 5001)
opciones { falsoUserToken?: EmulatorMockTokenOptions | cadena; }. Opciones del emulador. options.mockUserToken es el token de autenticación simulado que se usará para las reglas de seguridad de prueba de unidades.

Muestra:

void

ref(almacenamiento, url)

Muestra una StorageReference para la URL determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
almacenamiento FirebaseStorage FirebaseStorage.
url string la URL. Si está vacío, muestra la referencia raíz.

Muestra:

Referencia de Storage

función(ref, ...)

deleteObject(ref)

Borra el objeto en esta ubicación.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference del objeto que se borrará.

Muestra:

Promise&lt;void&gt;

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

getBlob(ref, maxDownloadSizeBytes)

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

Para usar esta funcionalidad, debes incluir en la lista blanca el origen de tu app en el bucket de Cloud Storage. Consulta también https://cloud.google.com/storage/docs/setting-cors

Esta API no está disponible en Node.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference en la que se deben descargar los datos.
maxDownloadSizeBytes número Si se establece, el tamaño máximo permitido en bytes que se debe recuperar.

Muestra:

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. Muestra un error si no se encuentra el objeto.

Para usar esta funcionalidad, debes incluir en la lista blanca el origen de tu app en el bucket de Cloud Storage. Consulta también https://cloud.google.com/storage/docs/configuration-cors

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference en la que se deben descargar los datos.
maxDownloadSizeBytes número Si se establece, el tamaño máximo permitido en bytes que se debe recuperar.

Muestra:

Promesa<ArrayBuffer>

Una promesa que contiene los bytes del objeto

getDownloadURL(ref)

Muestra la URL de descarga de la StorageReference determinada.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference para obtener la URL de descarga.

Muestra:

Promesa<string>

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

getMetadata(ref)

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference para obtener los metadatos.

Muestra:

Promesa<FullMetadata>

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

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference en la que se deben descargar los datos.
maxDownloadSizeBytes número Si se establece, el tamaño máximo permitido en bytes que se debe recuperar.

Muestra:

NodeJS.ReadableStream

Un flujo con los datos del objeto como bytes

list(ref, opciones)

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

La API de List solo está disponible para la versión 2 de las reglas de Firebase.

GCS es un almacén de BLOB de claves. Firebase Storage impone la semántica de “/”. de carpetas delimitadas. Consulta la API de List de GCS si deseas obtener más información.

Para cumplir con la semántica de las reglas de Firebase, Firebase Storage no admite objetos cuyas rutas de acceso terminen en “/”. o contener dos “/” consecutivas. La API de Firebase Storage List filtrará estos objetos no admitidos. list() puede fallar si hay demasiados objetos incompatibles en el bucket.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference para obtener la lista.
opciones Opciones de lista Consulta ListOptions para obtener más información.

Muestra:

Promesa<ListResult>

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

listAll(ref)

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

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

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference para obtener la lista.

Muestra:

Promesa<ListResult>

Un Promise que se resuelve con todos los elementos y prefijos de la referencia de almacenamiento actual. prefixes contiene referencias a subdirectorios y items contiene referencias a los objetos de la carpeta. Nunca se devuelve nextPageToken.

updateMetadata(ref, metadatos)

Actualiza los metadatos de este objeto.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference para actualizar los metadatos.
metadatos SettableMetadata Los metadatos nuevos del objeto. Solo se modificarán los valores que se establecieron explícitamente. Si se configura de forma explícita un valor como nulo, se quitarán los metadatos.

Muestra:

Promesa<FullMetadata>

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

uploadBytes(ref, datos, metadatos)

Sube datos a la ubicación de este objeto. No se puede reanudar la carga.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference donde se deben subir los datos.
datos Blob | Uint8Array | ArrayBuffer Los datos que se subirán.
metadatos UploadMetadata Metadatos de los datos que se subirán.

Muestra:

Promesa<UploadResult>

Una promesa que contiene un UploadResult

uploadBytesResumable(ref, datos, metadatos)

Sube datos a la ubicación de este objeto. La carga se puede pausar y reanudar, y expone las actualizaciones de progreso.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference donde se deben subir los datos.
datos Blob | Uint8Array | ArrayBuffer Los datos que se subirán.
metadatos UploadMetadata Metadatos de los datos que se subirán.

Muestra:

UploadTask

Un UploadTask

uploadString(ref, valor, formato, metadatos)

Sube una cadena a la ubicación de este objeto. No se puede reanudar la carga.

Firma:

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

Parámetros

Parámetro Tipo Descripción
ref Referencia de Storage StorageReference donde se debe subir la cadena.
valor string Cadena que se subirá.
formato StringFormat Es el formato de la cadena que se subirá.
metadatos UploadMetadata Metadatos de la cadena que se subirá.

Muestra:

Promesa<UploadResult>

Una promesa que contiene un UploadResult

función(storageOrRef, ...)

ref(storageOrRef, ruta)

Muestra una StorageReference para la ruta de acceso determinada en el bucket predeterminado.

Firma:

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

Parámetros

Parámetro Tipo Descripción
almacenamientoOrRef FirebaseStorage | Referencia de Storage FirebaseStorage o StorageReference
ruta string

Muestra:

Referencia de Storage

Formato de cadena

Una enumeración de los posibles formatos de cadena para la carga.

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 la carga.

Firma:

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

TaskEvent

Un evento que se activa 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';

StorageErrorCode

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

Firma:

export declare enum StorageErrorCode

Miembros de enumeración

Miembro Valor Descripción
APP_BORRADO "app-deleted"
BUCKET_NOT_FOUND "bucket-not-found"
CANCELADO "canceled"
CANNOT_SLICE_BLOB "cannot-slice-blob"
INTERNAL_ERROR "internal-error"
INVALID_ARGUMENT "invalid-argument"
INVALID_ARGUMENT_COUNT "invalid-argument-count"
SUMA_DE_CONFIRMACIÓN NO VÁLIDA "invalid-checksum"
INVALID_DEFAULT_BUCKET "invalid-default-bucket"
INVALID_EVENT_NAME "invalid-event-name"
INVALID_FORMAT "invalid-format"
OPERACIÓN_ROOT_NO_VÁLIDA "invalid-root-operation"
URL NO VÁLIDA "invalid-url"
NO_DEFAULT_BUCKET "no-default-bucket"
NO_DESCARGAR_URL "no-download-url"
OBJETO_NO_ENCONTRADO "object-not-found"
PROYECTO NO ENCONTRADO "project-not-found"
CUOTA_EXCEDAD "quota-exceeded"
RETRY_LIMIT_EXCEEDED "retry-limit-exceeded"
SERVER_FILE_WRONG_SIZE "server-file-wrong-size"
UNAUTHENTICATED "unauthenticated"
UNAUTHORIZED "unauthorized"
APLICACIÓN NO AUTORIZADA "unauthorized-app"
DESCONOCIDO "unknown"
ENTORNO_NO_COMPATIBLE "unsupported-environment"