Almacenamiento en la nube para Firebase
Funciones
Función | Descripción |
---|---|
función (aplicación...) | |
getStorage(aplicación, URL del depósito) | Obtiene una instancia de FirebaseStorage para la aplicación de Firebase determinada. |
función (almacenamiento...) | |
connectStorageEmulator (almacenamiento, host, puerto, opciones) | Modifique esta instancia de FirebaseStorage para comunicarse con el emulador de Cloud Storage. |
ref(almacenamiento, URL) | Devuelve una StorageReference para la URL dada. |
función (ref...) | |
eliminarObjeto(ref) | Elimina el objeto en esta ubicación. |
getBlob(ref, maxDownloadSizeBytes) | Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto. Para usar esta funcionalidad, debe incluir en la lista blanca el origen de su aplicación 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. |
getBytes(ref, maxDownloadSizeBytes) | Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto. Para usar esta funcionalidad, debe incluir en la lista blanca el origen de su aplicación en su depósito de Cloud Storage. Consulte también https://cloud.google.com/storage/docs/configuring-cors |
obtener URL de descarga (ref) | Devuelve la URL de descarga para la StorageReference dada . |
obtener metadatos (ref) | Una Promise que se resuelve con los metadatos de este objeto. Si este objeto no existe o no se pueden recuperar los metadatos, 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. |
lista (ref, opciones) | Enumere elementos (archivos) y prefijos (carpetas) bajo esta referencia de almacenamiento. La API de lista solo está disponible para la versión 2 de las reglas de Firebase. GCS es un almacén de blobs de claves. Firebase Storage impone la semántica de la estructura de carpetas delimitada 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 "/" consecutivos. Firebase Storage List API filtrará estos objetos no admitidos. list() puede fallar si hay demasiados objetos no admitidos en el depósito. |
enumerarTodo(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. Nota: Es posible que los resultados no sean coherentes si se modifican los objetos mientras se ejecuta esta operación. Advertencia: listAll puede potencialmente consumir demasiados recursos si hay demasiados resultados. |
updateMetadata(ref, metadatos) | Actualiza los metadatos de este objeto. |
uploadBytes (ref, datos, metadatos) | Sube datos a la ubicación de este objeto. La carga no es reanudable. |
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) | Carga una cadena en la ubicación de este objeto. La carga no es reanudable. |
función(almacenamientoOReferencia...) | |
ref(almacenamientoOrRef, ruta) | Devuelve una StorageReference para la ruta dada en el depósito predeterminado. |
Clases
Clase | Descripción |
---|---|
Error de almacenamiento | Un error devuelto por el SDK de Firebase Storage. |
enumeraciones
Enumeración | Descripción |
---|---|
Código de error de almacenamiento | Códigos de error que se pueden adjuntar a objetos StorageError . |
Interfaces
Interfaz | Descripción |
---|---|
FirebaseAlmacenamiento | Una instancia de Firebase Storage. |
metadatos completos | El conjunto completo de metadatos de objetos, incluidas las propiedades de solo lectura. |
ListaOpciones | La list() acepta. |
Resultado de la lista | Resultado devuelto por list(). |
Metadatos configurables | Metadatos de objetos que se pueden configurar en cualquier momento. |
StorageObserver | Un observador de flujo para Firebase Storage. |
AlmacenamientoReferencia | Representa una referencia a un objeto de Google Cloud Storage. Los desarrolladores pueden cargar, descargar y eliminar objetos, así como obtener/establecer metadatos de objetos. |
Cargar metadatos | Metadatos de objeto que se pueden configurar en la carga. |
CargarResultado | Resultado devuelto de una carga no reanudable. |
Subir tarea | Representa el proceso de carga de un objeto. Le permite monitorear y administrar la carga. |
SubirTareaInstantánea | Contiene datos sobre el estado actual de la tarea de carga. |
Variables
Variable | Descripción |
---|---|
formato de cadena | Una enumeración de los posibles formatos de cadena para cargar. |
Tipo de alias
Alias de tipo | Descripción |
---|---|
formato de cadena | Una enumeración de los posibles formatos de cadena para cargar. |
Evento de tarea | Un evento que se activa en una tarea. |
estado de la tarea | Representa el estado actual de una carga en ejecución. |
obtenerAlmacenamiento()
Obtiene una instancia de FirebaseStorage para la aplicación de Firebase dada.
Firma:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
aplicación | FirebaseApp | Aplicación de Firebase para obtener la instancia de FirebaseStorage . |
cuboUrl | cadena | La URL gs:// de su depósito de almacenamiento de Firebase. Si no se pasa, usa el depósito de almacenamiento predeterminado de la aplicación. |
Devoluciones:
Una instancia de FirebaseStorage .
conectarStorageEmulator()
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
Parámetro | Tipo | Descripción |
---|---|---|
almacenamiento | FirebaseAlmacenamiento | La instancia de FirebaseStorage |
anfitrión | cadena | El host del emulador (por ejemplo: localhost) |
puerto | número | El puerto del emulador (ej: 5001) |
opciones | { mockUserToken?: EmulatorMockTokenOptions | cadena; } | Opciones del emulador. options.mockUserToken es el token de autenticación simulado que se usa para las reglas de seguridad de pruebas unitarias. |
Devoluciones:
vacío
árbitro()
Devuelve una StorageReference para la URL dada.
Firma:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
almacenamiento | FirebaseAlmacenamiento | Instancia de FirebaseStorage . |
URL | cadena | URL Si está vacío, devuelve la referencia raíz. |
Devoluciones:
borrarObjeto()
Elimina el objeto en esta ubicación.
Firma:
export declare function deleteObject(ref: StorageReference): Promise<void>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para el objeto a eliminar. |
Devoluciones:
Promesa <vacío>
Una Promise
que se resuelve si la eliminación tiene éxito.
obtenerBlob()
Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto.
Para usar esta funcionalidad, debe incluir en la lista blanca el origen de su aplicación 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
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben descargar los datos. |
maxDownloadSizeBytes | número | Si se establece, el tamaño máximo permitido en bytes para recuperar. |
Devoluciones:
Promesa<Blob>
Una promesa que se resuelve con un blob que contiene los bytes del objeto.
obtenerBytes()
Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto.
Para usar esta funcionalidad, debe incluir en la lista blanca el origen de su aplicación 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
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben descargar los datos. |
maxDownloadSizeBytes | número | Si se establece, el tamaño máximo permitido en bytes para recuperar. |
Devoluciones:
Promesa <ArrayBuffer>
Una promesa que contiene los bytes del objeto.
getDownloadURL()
Devuelve la URL de descarga para la StorageReference dada .
Firma:
export declare function getDownloadURL(ref: StorageReference): Promise<string>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para obtener la URL de descarga. |
Devoluciones:
Promesa <cadena>
Una Promise
que se resuelve con la URL de descarga de este objeto.
obtenermetadatos()
Una Promise
que se resuelve con los metadatos de este objeto. Si este objeto no existe o no se pueden recuperar los metadatos, se rechaza la promesa.
Firma:
export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para obtener metadatos. |
Devoluciones:
Promesa< Metadatos completos >
getStream()
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 |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben descargar los datos. |
maxDownloadSizeBytes | número | Si se establece, el tamaño máximo permitido en bytes para recuperar. |
Devoluciones:
NodeJS.ReadableStream
Una secuencia con los datos del objeto como bytes.
lista()
Enumere elementos (archivos) y prefijos (carpetas) bajo esta referencia de almacenamiento.
La API de lista solo está disponible para la versión 2 de las reglas de Firebase.
GCS es un almacén de blobs de claves. Firebase Storage impone la semántica de la estructura de carpetas delimitada 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 "/" consecutivos. Firebase Storage List API filtrará estos objetos no admitidos. list() puede fallar si hay demasiados objetos no admitidos en el depósito.
Firma:
export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para obtener la lista. |
opciones | ListaOpciones | Ver ListOptions para más detalles. |
Devoluciones:
Promesa< ListResult >
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 usar para obtener el resto de los resultados.
Listar todo()
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
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para obtener la lista. |
Devoluciones:
Promesa< ListResult >
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()
Actualiza los metadatos de este objeto.
Firma:
export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para actualizar los metadatos. |
metadatos | Metadatos configurables | Los nuevos metadatos del objeto. Solo se cambiarán los valores que se hayan establecido explícitamente. Establecer explícitamente un valor en nulo eliminará los metadatos. |
Devoluciones:
Promesa< Metadatos Completos >
Una Promise
que se resuelve con los nuevos metadatos para este objeto.
cargarBytes()
Sube datos a la ubicación de este objeto. La carga no es reanudable.
Firma:
export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben cargar los datos. |
datos | gota | Uint8Array | Matriz de búfer | Los datos a cargar. |
metadatos | Cargar metadatos | Metadatos para que los datos se carguen. |
Devoluciones:
Promesa< CargarResultado >
Una promesa que contiene un resultado de carga
uploadBytesResumible()
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 |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben cargar los datos. |
datos | gota | Uint8Array | Matriz de búfer | Los datos a cargar. |
metadatos | Cargar metadatos | Metadatos para que los datos se carguen. |
Devoluciones:
Una tarea de carga
subirCadena()
Carga una cadena en la ubicación de este objeto. La carga no es reanudable.
Firma:
export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se debe cargar la cadena. |
valor | cadena | La cadena a cargar. |
formato | formato de cadena | El formato de la cadena a cargar. |
metadatos | Cargar metadatos | Metadatos para que la cadena se cargue. |
Devoluciones:
Promesa< CargarResultado >
Una promesa que contiene un resultado de carga
árbitro()
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
Parámetro | Tipo | Descripción |
---|---|---|
almacenamientoOrRef | Almacenamiento de base de fuego | AlmacenamientoReferencia | FirebaseStorage o StorageReference . |
camino | cadena |
Devoluciones:
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 activa en una tarea.
Firma:
export declare type TaskEvent = 'state_changed';
estado de la 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
Miembro | Valor | Descripción |
---|---|---|
APLICACIÓN_ELIMINADA | "app-deleted" | |
CUBO_NO_ENCONTRADO | "bucket-not-found" | |
CANCELADO | "canceled" | |
NO PUEDE_SLICE_BLOB | "cannot-slice-blob" | |
ERROR INTERNO | "internal-error" | |
ARGUMENTO NO VÁLIDO | "invalid-argument" | |
INVALID_ARGUMENT_COUNT | "invalid-argument-count" | |
INVALID_CHECKSUM | "invalid-checksum" | |
INVALID_DEFAULT_BUCKET | "invalid-default-bucket" | |
INVALID_EVENT_NAME | "invalid-event-name" | |
FORMATO INVÁLIDO | "invalid-format" | |
INVALID_ROOT_OPERATION | "invalid-root-operation" | |
URL INVALIDA | "invalid-url" | |
NO_DEFAULT_BUCKET | "no-default-bucket" | |
NO_DOWNLOAD_URL | "no-download-url" | |
OBJETO NO ENCONTRADO | "object-not-found" | |
PROYECTO_NO_ENCONTRADO | "project-not-found" | |
CUOTA EXCEDIDA | "quota-exceeded" | |
RETRY_LIMIT_EXCEEDED | "retry-limit-exceeded" | |
SERVIDOR_FILE_WRONG_SIZE | "server-file-wrong-size" | |
NO AUTENTIFICADO | "unauthenticated" | |
NO AUTORIZADO | "unauthorized" | |
APLICACIÓN_NO AUTORIZADA | "unauthorized-app" | |
DESCONOCIDO | "unknown" | |
ENTORNO_NO COMPATIBLE | "unsupported-environment" |
Almacenamiento en la nube para Firebase
Funciones
Función | Descripción |
---|---|
función (aplicación...) | |
getStorage(aplicación, URL del depósito) | Obtiene una instancia de FirebaseStorage para la aplicación de Firebase determinada. |
función (almacenamiento...) | |
connectStorageEmulator (almacenamiento, host, puerto, opciones) | Modifique esta instancia de FirebaseStorage para comunicarse con el emulador de Cloud Storage. |
ref(almacenamiento, URL) | Devuelve una StorageReference para la URL dada. |
función (ref...) | |
eliminarObjeto(ref) | Elimina el objeto en esta ubicación. |
getBlob(ref, maxDownloadSizeBytes) | Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto. Para usar esta funcionalidad, debe incluir en la lista blanca el origen de su aplicación 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. |
getBytes(ref, maxDownloadSizeBytes) | Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto. Para usar esta funcionalidad, debe incluir en la lista blanca el origen de su aplicación en su depósito de Cloud Storage. Consulte también https://cloud.google.com/storage/docs/configuring-cors |
obtener URL de descarga (ref) | Devuelve la URL de descarga para la StorageReference dada . |
obtener metadatos (ref) | Una Promise que se resuelve con los metadatos de este objeto. Si este objeto no existe o no se pueden recuperar los metadatos, 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. |
lista (ref, opciones) | Enumere elementos (archivos) y prefijos (carpetas) bajo esta referencia de almacenamiento. La API de lista solo está disponible para la versión 2 de las reglas de Firebase. GCS es un almacén de blobs de claves. Firebase Storage impone la semántica de la estructura de carpetas delimitada 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 "/" consecutivos. Firebase Storage List API filtrará estos objetos no admitidos. list() puede fallar si hay demasiados objetos no admitidos en el depósito. |
enumerarTodo(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. Nota: Es posible que los resultados no sean coherentes si se modifican los objetos mientras se ejecuta esta operación. Advertencia: listAll puede potencialmente consumir demasiados recursos si hay demasiados resultados. |
updateMetadata(ref, metadatos) | Actualiza los metadatos de este objeto. |
uploadBytes (ref, datos, metadatos) | Sube datos a la ubicación de este objeto. La carga no es reanudable. |
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) | Carga una cadena en la ubicación de este objeto. La carga no es reanudable. |
función(almacenamientoOReferencia...) | |
ref(almacenamientoOrRef, ruta) | Devuelve una StorageReference para la ruta dada en el depósito predeterminado. |
Clases
Clase | Descripción |
---|---|
Error de almacenamiento | Un error devuelto por el SDK de Firebase Storage. |
enumeraciones
Enumeración | Descripción |
---|---|
Código de error de almacenamiento | Códigos de error que se pueden adjuntar a objetos StorageError . |
Interfaces
Interfaz | Descripción |
---|---|
FirebaseAlmacenamiento | Una instancia de Firebase Storage. |
metadatos completos | El conjunto completo de metadatos de objetos, incluidas las propiedades de solo lectura. |
ListaOpciones | La list() acepta. |
Resultado de la lista | Resultado devuelto por list(). |
Metadatos configurables | Metadatos de objetos que se pueden configurar en cualquier momento. |
StorageObserver | Un observador de flujo para Firebase Storage. |
AlmacenamientoReferencia | Representa una referencia a un objeto de Google Cloud Storage. Los desarrolladores pueden cargar, descargar y eliminar objetos, así como obtener/establecer metadatos de objetos. |
Cargar metadatos | Metadatos de objeto que se pueden configurar en la carga. |
CargarResultado | Resultado devuelto de una carga no reanudable. |
Subir tarea | Representa el proceso de carga de un objeto. Le permite monitorear y administrar la carga. |
SubirTareaInstantánea | Contiene datos sobre el estado actual de la tarea de carga. |
Variables
Variable | Descripción |
---|---|
formato de cadena | Una enumeración de los posibles formatos de cadena para cargar. |
Tipo de alias
Alias de tipo | Descripción |
---|---|
formato de cadena | Una enumeración de los posibles formatos de cadena para cargar. |
Evento de tarea | Un evento que se activa en una tarea. |
estado de la tarea | Representa el estado actual de una carga en ejecución. |
obtenerAlmacenamiento()
Obtiene una instancia de FirebaseStorage para la aplicación de Firebase dada.
Firma:
export declare function getStorage(app?: FirebaseApp, bucketUrl?: string): FirebaseStorage;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
aplicación | FirebaseApp | Aplicación de Firebase para obtener la instancia de FirebaseStorage . |
cuboUrl | cadena | La URL gs:// de su depósito de almacenamiento de Firebase. Si no se pasa, usa el depósito de almacenamiento predeterminado de la aplicación. |
Devoluciones:
Una instancia de FirebaseStorage .
conectarStorageEmulator()
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
Parámetro | Tipo | Descripción |
---|---|---|
almacenamiento | FirebaseAlmacenamiento | La instancia de FirebaseStorage |
anfitrión | cadena | El host del emulador (por ejemplo: localhost) |
puerto | número | El puerto del emulador (ej: 5001) |
opciones | { mockUserToken?: EmulatorMockTokenOptions | cadena; } | Opciones del emulador. options.mockUserToken es el token de autenticación simulado que se usa para las reglas de seguridad de pruebas unitarias. |
Devoluciones:
vacío
árbitro()
Devuelve una StorageReference para la URL dada.
Firma:
export declare function ref(storage: FirebaseStorage, url?: string): StorageReference;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
almacenamiento | FirebaseAlmacenamiento | Instancia de FirebaseStorage . |
URL | cadena | URL Si está vacío, devuelve la referencia raíz. |
Devoluciones:
borrarObjeto()
Elimina el objeto en esta ubicación.
Firma:
export declare function deleteObject(ref: StorageReference): Promise<void>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para el objeto a eliminar. |
Devoluciones:
Promesa <vacío>
Una Promise
que se resuelve si la eliminación tiene éxito.
obtenerBlob()
Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto.
Para usar esta funcionalidad, debe incluir en la lista blanca el origen de su aplicación 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
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben descargar los datos. |
maxDownloadSizeBytes | número | Si se establece, el tamaño máximo permitido en bytes para recuperar. |
Devoluciones:
Promesa<Blob>
Una promesa que se resuelve con un blob que contiene los bytes del objeto.
obtenerBytes()
Descarga los datos en la ubicación del objeto. Devuelve un error si no se encuentra el objeto.
Para usar esta funcionalidad, debe incluir en la lista blanca el origen de su aplicación 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
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben descargar los datos. |
maxDownloadSizeBytes | número | Si se establece, el tamaño máximo permitido en bytes para recuperar. |
Devoluciones:
Promesa <ArrayBuffer>
Una promesa que contiene los bytes del objeto.
getDownloadURL()
Devuelve la URL de descarga para la StorageReference dada .
Firma:
export declare function getDownloadURL(ref: StorageReference): Promise<string>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para obtener la URL de descarga. |
Devoluciones:
Promesa <cadena>
Una Promise
que se resuelve con la URL de descarga de este objeto.
obtenermetadatos()
Una Promise
que se resuelve con los metadatos de este objeto. Si este objeto no existe o no se pueden recuperar los metadatos, se rechaza la promesa.
Firma:
export declare function getMetadata(ref: StorageReference): Promise<FullMetadata>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para obtener metadatos. |
Devoluciones:
Promesa< Metadatos completos >
getStream()
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 |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben descargar los datos. |
maxDownloadSizeBytes | número | Si se establece, el tamaño máximo permitido en bytes para recuperar. |
Devoluciones:
NodeJS.ReadableStream
Una secuencia con los datos del objeto como bytes.
lista()
Enumere elementos (archivos) y prefijos (carpetas) bajo esta referencia de almacenamiento.
La API de lista solo está disponible para la versión 2 de las reglas de Firebase.
GCS es un almacén de blobs de claves. Firebase Storage impone la semántica de la estructura de carpetas delimitada 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 "/" consecutivos. Firebase Storage List API filtrará estos objetos no admitidos. list() puede fallar si hay demasiados objetos no admitidos en el depósito.
Firma:
export declare function list(ref: StorageReference, options?: ListOptions): Promise<ListResult>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para obtener la lista. |
opciones | ListaOpciones | Ver ListOptions para más detalles. |
Devoluciones:
Promesa< ListResult >
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 usar para obtener el resto de los resultados.
Listar todo()
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
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para obtener la lista. |
Devoluciones:
Promesa< ListResult >
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()
Actualiza los metadatos de este objeto.
Firma:
export declare function updateMetadata(ref: StorageReference, metadata: SettableMetadata): Promise<FullMetadata>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference para actualizar los metadatos. |
metadatos | Metadatos configurables | Los nuevos metadatos del objeto. Solo se cambiarán los valores que se hayan establecido explícitamente. Establecer explícitamente un valor en nulo eliminará los metadatos. |
Devoluciones:
Promesa< Metadatos Completos >
Una Promise
que se resuelve con los nuevos metadatos para este objeto.
cargarBytes()
Sube datos a la ubicación de este objeto. La carga no es reanudable.
Firma:
export declare function uploadBytes(ref: StorageReference, data: Blob | Uint8Array | ArrayBuffer, metadata?: UploadMetadata): Promise<UploadResult>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben cargar los datos. |
datos | gota | Uint8Array | Matriz de búfer | Los datos a cargar. |
metadatos | Cargar metadatos | Metadatos para que los datos se carguen. |
Devoluciones:
Promesa< CargarResultado >
Una promesa que contiene un resultado de carga
uploadBytesResumible()
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 |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se deben cargar los datos. |
datos | gota | Uint8Array | Matriz de búfer | Los datos a cargar. |
metadatos | Cargar metadatos | Metadatos para que los datos se carguen. |
Devoluciones:
Una tarea de carga
subirCadena()
Carga una cadena en la ubicación de este objeto. La carga no es reanudable.
Firma:
export declare function uploadString(ref: StorageReference, value: string, format?: StringFormat, metadata?: UploadMetadata): Promise<UploadResult>;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
árbitro | AlmacenamientoReferencia | StorageReference donde se debe cargar la cadena. |
valor | cadena | La cadena a cargar. |
formato | formato de cadena | El formato de la cadena a cargar. |
metadatos | Cargar metadatos | Metadatos para que la cadena se cargue. |
Devoluciones:
Promesa< CargarResultado >
Una promesa que contiene un resultado de carga
árbitro()
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
Parámetro | Tipo | Descripción |
---|---|---|
almacenamientoOrRef | Almacenamiento de base de fuego | AlmacenamientoReferencia | FirebaseStorage o StorageReference . |
camino | cadena |
Devoluciones:
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 la 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
Miembro | Valor | Descripción |
---|---|---|
APLICACIÓN_ELIMINADA | "app-deleted" | |
CUBO_NO_ENCONTRADO | "bucket-not-found" | |
CANCELADO | "canceled" | |
NO PUEDE_SLICE_BLOB | "cannot-slice-blob" | |
ERROR INTERNO | "internal-error" | |
ARGUMENTO NO VÁLIDO | "invalid-argument" | |
INVALID_ARGUMENT_COUNT | "invalid-argument-count" | |
INVALID_CHECKSUM | "invalid-checksum" | |
INVALID_DEFAULT_BUCKET | "invalid-default-bucket" | |
INVALID_EVENT_NAME | "invalid-event-name" | |
FORMATO INVÁLIDO | "invalid-format" | |
INVALID_ROOT_OPERATION | "invalid-root-operation" | |
URL INVALIDA | "invalid-url" | |
NO_DEFAULT_BUCKET | "no-default-bucket" | |
NO_DOWNLOAD_URL | "no-download-url" | |
OBJETO NO ENCONTRADO | "object-not-found" | |
PROYECTO_NO_ENCONTRADO | "project-not-found" | |
CUOTA EXCEDIDA | "quota-exceeded" | |
RETRY_LIMIT_EXCEEDED | "retry-limit-exceeded" | |
SERVIDOR_FILE_WRONG_SIZE | "server-file-wrong-size" | |
NO AUTENTIFICADO | "unauthenticated" | |
NO AUTORIZADO | "unauthorized" | |
APLICACIÓN_NO AUTORIZADA | "unauthorized-app" | |
DESCONOCIDO | "unknown" | |
ENTORNO_NO COMPATIBLE | "unsupported-environment" |