@firebase/firestore

Funciones

Función Descripción
función (aplicación, ...)
getFirestore (aplicación) Devuelve la instancia predeterminada existente de Firestore que está asociada con la FirebaseApp proporcionada. . Si no existe ninguna instancia, inicializa una nueva instancia con la configuración predeterminada.
getFirestore(aplicación, ID de base de datos) (BETA) Devuelve la instancia de Firestore con nombre existente que está asociada con la FirebaseApp proporcionada . Si no existe ninguna instancia, inicializa una nueva instancia con la configuración predeterminada.
inicializarFirestore(aplicación, configuración, ID de base de datos) Inicializa una nueva instancia de Firestore con la configuración proporcionada. Solo se puede llamar antes que cualquier otra función, incluida getFirestore() . Si la configuración personalizada está vacía, esta función equivale a llamar a getFirestore() .
función(firestore, ...)
clearIndexedDbPersistence(firestore) Borra el almacenamiento persistente. Esto incluye escrituras pendientes y documentos almacenados en caché. Se debe llamar mientras la instancia de Firestore no está iniciada (después de finalizar la aplicación o cuando la aplicación se inicializa por primera vez). Al inicio, esta función debe llamarse antes que otras funciones (que no sean initializeFirestore() o getFirestore() )). Si la instancia de Firestore aún se está ejecutando, la promesa se rechazará con el código de error de failed-precondition . Nota: clearIndexedDbPersistence() está destinado principalmente a ayudar a escribir pruebas confiables que utilicen Cloud Firestore. Utiliza un mecanismo eficiente para descartar datos existentes, pero no intenta sobrescribirlos de forma segura ni hacer que los datos almacenados en caché sean irrecuperables. Para las aplicaciones que son sensibles a la divulgación de datos almacenados en caché entre sesiones de usuario, recomendamos encarecidamente no habilitar la persistencia en absoluto.
colección (firestore, ruta, segmentos de ruta) Obtiene una instancia CollectionReference que hace referencia a la colección en la ruta absoluta especificada.
grupo de colección (firestore, ID de colección) Crea y devuelve una nueva instancia Query que incluye todos los documentos de la base de datos que están contenidos en una colección o subcolección con el collectionId dado.
connectFirestoreEmulator(firestore, host, puerto, opciones) Modifique esta instancia para comunicarse con el emulador de Cloud Firestore. Nota: Esto debe llamarse antes de que esta instancia se haya utilizado para realizar cualquier operación.
desactivarRed(firestore) Deshabilita el uso de la red para esta instancia. Se puede volver a habilitar a través de enableNetwork() . Mientras la red esté deshabilitada, cualquier escucha de instantáneas, llamadas getDoc() o getDocs() devolverán resultados del caché y cualquier operación de escritura se pondrá en cola hasta que se restablezca la red.
doc(firestore, ruta, segmentos de ruta) Obtiene una instancia DocumentReference que hace referencia al documento en la ruta absoluta especificada.
enableIndexedDbPersistence(firestore, persistenceSettings) Intenta habilitar el almacenamiento persistente, si es posible. En caso de error, enableIndexedDbPersistence() rechazará la promesa o generará una excepción. Hay varias razones por las que esto puede fallar, que pueden identificarse mediante el code del error. * condición previa fallida: la aplicación ya está abierta en otra pestaña del navegador. * no implementado: el navegador es incompatible con la implementación de persistencia fuera de línea. Tenga en cuenta que incluso después de una falla, la instancia de Firestore seguirá siendo utilizable; sin embargo, la persistencia sin conexión estará deshabilitada. Nota: se debe llamar enableIndexedDbPersistence() antes que cualquier otra función (que no sea inicializeFirestore() , getFirestore() o clearIndexedDbPersistence() . La persistencia no se puede utilizar en un entorno Node.js.
enableMultiTabIndexedDbPersistence (firestore) Intenta habilitar el almacenamiento persistente de varias pestañas, si es posible. Si se habilita en todas las pestañas, todas las operaciones comparten el acceso a la persistencia local, incluida la ejecución compartida de consultas y actualizaciones de documentos locales con latencia compensada en todas las instancias conectadas. En caso de error, enableMultiTabIndexedDbPersistence() rechazará la promesa o generará una excepción. Hay varias razones por las que esto puede fallar, que pueden identificarse mediante el code del error. * condición previa fallida: la aplicación ya está abierta en otra pestaña del navegador y la función de pestañas múltiples no está habilitada. * no implementado: el navegador es incompatible con la implementación de persistencia fuera de línea. Tenga en cuenta que incluso después de una falla, la instancia de Firestore seguirá siendo utilizable; sin embargo, la persistencia sin conexión estará deshabilitada.
habilitarNetwork(firestore) Vuelve a habilitar el uso de la red para esta instancia de Firestore después de una llamada previa a enableNetwork() .
getPersistentCacheIndexManager(firestore) Devuelve el administrador de índices PersistentCache utilizado por el objeto Firestore determinado. La instancia PersistentCacheIndexManager , o null si el almacenamiento persistente local no está en uso.
loadBundle(firestore, datos del paquete) Carga un paquete de Firestore en la caché local.
consulta nombrada (firestore, nombre) Lee una consulta de Firestore desde la caché local, identificada por el nombre de pila. Las consultas nombradas se empaquetan en paquetes en el lado del servidor (junto con los documentos resultantes) y se cargan en la caché local mediante loadBundle . Una vez en la caché local, utilice este método para extraer una consulta por nombre.
onSnapshotsInSync (firestore, observador) Adjunta un oyente para un evento de instantáneas sincronizadas. El evento de instantáneas sincronizadas indica que todos los oyentes afectados por un cambio determinado se han activado, incluso si un único cambio generado por el servidor afecta a varios oyentes. NOTA: El evento de instantáneas sincronizadas solo indica que los oyentes están sincronizados entre sí, pero no se relaciona con si esas instantáneas están sincronizadas con el servidor. Utilice SnapshotMetadata en los oyentes individuales para determinar si una instantánea proviene de la memoria caché o del servidor.
onSnapshotsInSync (firestore, onSync) Adjunta un oyente para un evento de instantáneas sincronizadas. El evento de instantáneas sincronizadas indica que todos los oyentes afectados por un cambio determinado se han activado, incluso si un único cambio generado por el servidor afecta a varios oyentes. NOTA: El evento de instantáneas sincronizadas solo indica que los oyentes están sincronizados entre sí, pero no se relaciona con si esas instantáneas están sincronizadas con el servidor. Utilice SnapshotMetadata en los oyentes individuales para determinar si una instantánea proviene de la memoria caché o del servidor.
runTransaction(firestore, updateFunction, opciones) Ejecuta la updateFunction dada y luego intenta confirmar los cambios aplicados dentro de la transacción. Si algún documento leído dentro de la transacción ha cambiado, Cloud Firestore vuelve a intentar la updateFunction . Si no se confirma después de 5 intentos, la transacción falla. El número máximo de escrituras permitidas en una sola transacción es 500.
setIndexConfiguration (firestore, configuración) (BETA) Configura la indexación para la ejecución de consultas locales. Se anula cualquier configuración de índice anterior. La Promise se resuelve una vez que se ha persistido la configuración del índice. Las propias entradas del índice se crean de forma asincrónica. Puede seguir utilizando consultas que requieran indexación incluso si los índices aún no están disponibles. La ejecución de la consulta comenzará automáticamente a utilizar el índice una vez que se hayan escrito las entradas del índice. Los índices solo se admiten con persistencia IndexedDb. Si IndexedDb no está habilitado, se ignora cualquier configuración de índice.
setIndexConfiguration(firestore, json) (BETA) Configura la indexación para la ejecución de consultas locales. Se anula cualquier configuración de índice anterior. La Promise se resuelve una vez que se ha persistido la configuración del índice. Las propias entradas del índice se crean de forma asincrónica. Puede seguir utilizando consultas que requieran indexación incluso si los índices aún no están disponibles. La ejecución de la consulta comenzará automáticamente a utilizar el índice una vez que se hayan escrito las entradas del índice. Los índices solo se admiten con persistencia IndexedDb. Invoque enableIndexedDbPersistence() o enableMultiTabIndexedDbPersistence() antes de establecer una configuración de índice. Si IndexedDb no está habilitado, se ignora cualquier configuración de índice. El método acepta el formato JSON exportado por Firebase CLI ( firebase firestore:indexes ). Si el formato JSON no es válido, este método arroja un error.
terminar (firestore) Termina la instancia de Firestore proporcionada. Después de llamar terminate() solo se puede utilizar la función clearIndexedDbPersistence() . Cualquier otra función arrojará un FirestoreError . Para reiniciar después de la terminación, cree una nueva instancia de FirebaseFirestore con getFirestore() . La terminación no cancela ninguna escritura pendiente y ninguna promesa que esté esperando una respuesta del servidor no se resolverá. Si tiene habilitada la persistencia, la próxima vez que inicie esta instancia, reanudará el envío de estas escrituras al servidor. Nota: En circunstancias normales, no es necesario llamar terminate() . Esta función es útil solo cuando desea forzar que esta instancia libere todos sus recursos o en combinación con clearIndexedDbPersistence() para garantizar que todo el estado local se destruya entre ejecuciones de prueba.
esperar para escrituras pendientes (firestore) Espera hasta que el backend haya reconocido todas las escrituras actualmente pendientes para el usuario activo. La promesa devuelta se resuelve inmediatamente si no hay escrituras pendientes. De lo contrario, la promesa espera todas las escrituras emitidas anteriormente (incluidas las escritas en una sesión de aplicación anterior), pero no espera las escrituras que se agregaron después de llamar a la función. Si desea esperar escrituras adicionales, llame nuevamente waitForPendingWrites() . Cualquier promesa pendiente de waitForPendingWrites() se rechaza durante los cambios de usuario.
escribir lote (firestore) Crea un lote de escritura, utilizado para realizar múltiples escrituras como una única operación atómica. El número máximo de escrituras permitidas en un único WriteBatch es 500. A diferencia de las transacciones, los lotes de escritura persisten fuera de línea y, por lo tanto, son preferibles cuando no necesita condicionar sus escrituras a los datos leídos.
función()
contar() Cree un objeto AggregateField que pueda usarse para calcular el recuento de documentos en el conjunto de resultados de una consulta.
eliminar campo() Devuelve un centinela para usar con updateDoc() o setDoc() con {merge: true} para marcar un campo para su eliminación.
documentoId() Devuelve un FieldPath centinela especial para hacer referencia al ID de un documento. Se puede utilizar en consultas para ordenar o filtrar por ID del documento.
obtenerFirestore() Devuelve la instancia de Firestore predeterminada existente que está asociada con la FirebaseApp predeterminada . Si no existe ninguna instancia, inicializa una nueva instancia con la configuración predeterminada.
memoriaEagerGarbageCollector() Crea una instancia de MemoryEagerGarbageCollector . Este también es el recolector de basura predeterminado a menos que se especifique explícitamente lo contrario.
persistenteMultipleTabManager() Crea una instancia de PersistentMultipleTabManager .
marca de tiempo del servidor() Devuelve un centinela usado con setDoc() o updateDoc() para incluir una marca de tiempo generada por el servidor en los datos escritos.
función (ID de base de datos, ...)
getFirestore(ID de base de datos) (BETA) Devuelve la instancia de Firestore con nombre existente que está asociada con la FirebaseApp predeterminada . Si no existe ninguna instancia, inicializa una nueva instancia con la configuración predeterminada.
función(elementos,...)
matrizEliminar(elementos) Devuelve un valor especial que se puede usar con setDoc() o que le dice al servidor que elimine los elementos dados de cualquier valor de matriz que ya exista en el servidor. Todas las instancias de cada elemento especificado se eliminarán de la matriz. Si el campo que se está modificando aún no es una matriz, se sobrescribirá con una matriz vacía.
matrizUnión(elementos) Devuelve un valor especial que se puede utilizar con setDoc() o updateDoc() que le indica al servidor que una los elementos dados con cualquier valor de matriz que ya exista en el servidor. Cada elemento especificado que aún no exista en la matriz se agregará al final. Si el campo que se está modificando aún no es una matriz, se sobrescribirá con una matriz que contenga exactamente los elementos especificados.
función(campo, ...)
promedio (campo) Cree un objeto AggregateField que pueda usarse para calcular el promedio de un campo específico en un rango de documentos en el conjunto de resultados de una consulta.
suma (campo) Cree un objeto AggregateField que pueda usarse para calcular la suma de un campo específico en un rango de documentos en el conjunto de resultados de una consulta.
función (ruta del campo, ...)
ordenar por (ruta del campo, cadena de dirección) Crea un QueryOrderByConstraint que ordena el resultado de la consulta por el campo especificado, opcionalmente en orden descendente en lugar de ascendente. Nota: Los documentos que no contengan el campo especificado no estarán presentes en el resultado de la consulta.
donde(rutacampo, opStr, valor) Crea un QueryFieldFilterConstraint que exige que los documentos deben contener el campo especificado y que el valor debe satisfacer la restricción de relación proporcionada.
función (valores de campo, ...)
final en (valores de campo) Crea un QueryEndAtConstraint que modifica el conjunto de resultados para que finalice en los campos proporcionados en relación con el orden de la consulta. El orden de los valores de los campos debe coincidir con el orden de las cláusulas de orden por de la consulta.
finalizar antes (valores de campo) Crea un QueryEndAtConstraint que modifica el conjunto de resultados para que finalice antes de los campos proporcionados en relación con el orden de la consulta. El orden de los valores de los campos debe coincidir con el orden de las cláusulas de orden por de la consulta.
empezar después (valores de campo) Crea un QueryStartAtConstraint que modifica el conjunto de resultados para que comience después de los campos proporcionados en relación con el orden de la consulta. El orden de los valores de los campos debe coincidir con el orden de las cláusulas de orden por de la consulta.
inicio en (valores de campo) Crea un QueryStartAtConstraint que modifica el conjunto de resultados para comenzar en los campos proporcionados en relación con el orden de la consulta. El orden de los valores de los campos debe coincidir con el orden de las cláusulas de orden por de la consulta.
función (administrador de índices, ...)
eliminarAllPersistentCacheIndexes(indexManager) Elimina todos los índices de caché persistentes. Tenga en cuenta que esta función también eliminará los índices generados por setIndexConfiguration() , que está en desuso.
desactivarPersistentCacheIndexAutoCreation(indexManager) Deja de crear índices de caché persistentes automáticamente para la ejecución de consultas locales. Los índices que se crearon llamando enablePersistentCacheIndexAutoCreation() aún tienen efecto.
enablePersistentCacheIndexAutoCreation(indexManager) Permite que el SDK cree automáticamente índices de caché persistentes para la ejecución de consultas locales cuando el SDK cree que los índices de caché pueden ayudar a mejorar el rendimiento. Esta función esta desactivada por defecto.
función(izquierda, ...)
agregadoFieldEqual(izquierda, derecha) Compara dos 'AggregateField ` instancias para la igualdad.
agregadoQuerySnapshotEqual(izquierda, derecha) Compara dos instancias AggregateQuerySnapshot para determinar la igualdad. Dos instancias AggregateQuerySnapshot se consideran "iguales" si tienen consultas subyacentes que comparan datos iguales y iguales.
consultaIgual(izquierda, derecha) Devuelve verdadero si las consultas proporcionadas apuntan a la misma colección y aplican las mismas restricciones.
refEqual(izquierda, derecha) Devuelve verdadero si las referencias proporcionadas son iguales.
instantáneaEqual(izquierda, derecha) Devuelve verdadero si las instantáneas proporcionadas son iguales.
función(límite, ...)
límite(límite) Crea un QueryLimitConstraint que solo devuelve los primeros documentos coincidentes.
límite al último (límite) Crea un QueryLimitConstraint que solo devuelve los últimos documentos coincidentes. Debe especificar al menos una cláusula orderBy para las consultas limitToLast ; de lo contrario, se generará una excepción durante la ejecución.
función (nivel de registro, ...)
setLogLevel(logLevel) Establece el nivel de detalle de los registros de Cloud Firestore (depuración, error o silencio).
función(n, ...)
incremento(n) Devuelve un valor especial que se puede utilizar con setDoc() o updateDoc() que le indica al servidor que incremente el valor actual del campo en el valor dado. Si el operando o el valor del campo actual utiliza precisión de punto flotante, toda la aritmética sigue la semántica IEEE 754. Si ambos valores son enteros, los valores fuera del rango de números seguros de JavaScript ( Number.MIN_SAFE_INTEGER a Number.MAX_SAFE_INTEGER ) también están sujetos a pérdida de precisión. Además, una vez procesadas por el backend de Firestore, todas las operaciones con números enteros tienen un límite entre -2^63 y 2^63-1. Si el valor del campo actual no es del tipo number , o si el campo aún no existe, la transformación establece el campo en el valor dado.
función (consulta, ...)
getAggregateFromServer (consulta, especificación agregada) Calcula las agregaciones especificadas sobre los documentos en el conjunto de resultados de la consulta dada sin descargar realmente los documentos. Usar esta función para realizar agregaciones es eficiente porque solo se descargan los valores de agregación finales, no los datos de los documentos. Esta función puede realizar agregaciones de documentos en los casos en que el conjunto de resultados sea prohibitivamente grande para descargarlo por completo (miles de documentos). El resultado recibido del servidor se presenta inalterado, sin considerar ningún estado local. Es decir, no se tienen en cuenta los documentos en la caché local ni las modificaciones locales que aún no estén sincronizadas con el servidor. Los resultados descargados previamente, si los hay, no se utilizan. Cada invocación de esta función implica necesariamente un viaje de ida y vuelta al servidor.
getCountFromServer(consulta) Calcula la cantidad de documentos en el conjunto de resultados de la consulta dada sin descargar los documentos. Usar esta función para contar los documentos es eficiente porque solo se descarga el recuento final, no los datos de los documentos. Esta función puede contar los documentos en los casos en que el conjunto de resultados sea prohibitivamente grande para descargarlo por completo (miles de documentos). El resultado recibido del servidor se presenta inalterado, sin considerar ningún estado local. Es decir, no se tienen en cuenta los documentos en la caché local ni las modificaciones locales que aún no estén sincronizadas con el servidor. Los resultados descargados previamente, si los hay, no se utilizan. Cada invocación de esta función implica necesariamente un viaje de ida y vuelta al servidor.
obtenerDocs(consulta) Ejecuta la consulta y devuelve los resultados como QuerySnapshot . Nota: getDocs() intenta proporcionar datos actualizados cuando es posible esperando datos del servidor, pero puede devolver datos almacenados en caché o fallar si no está conectado y no se puede acceder al servidor. Para especificar este comportamiento, invoque getDocsFromCache() o getDocsFromServer() .
getDocsFromCache(consulta) Ejecuta la consulta y devuelve los resultados como una QuerySnapshot desde la memoria caché. Devuelve un conjunto de resultados vacío si actualmente no hay en caché ningún documento que coincida con la consulta.
getDocsFromServer (consulta) Ejecuta la consulta y devuelve los resultados como una QuerySnapshot del servidor. Devuelve un error si la red no está disponible.
onSnapshot (consulta, observador) Adjunta un detector para eventos QuerySnapshot . Puede pasar devoluciones de llamada onNext y onError individuales o pasar un único objeto observador con devoluciones de llamada next y error . El oyente se puede cancelar llamando a la función que se devuelve cuando se llama a onSnapshot . NOTA: Aunque se puede proporcionar una devolución de llamada onCompletion , nunca se llamará porque la secuencia de instantáneas es interminable.
onSnapshot(consulta, opciones, observador) Adjunta un detector para eventos QuerySnapshot . Puede pasar devoluciones de llamada onNext y onError individuales o pasar un único objeto observador con devoluciones de llamada next y error . El oyente se puede cancelar llamando a la función que se devuelve cuando se llama a onSnapshot . NOTA: Aunque se puede proporcionar una devolución de llamada onCompletion , nunca se llamará porque la secuencia de instantáneas es interminable.
onSnapshot(consulta, onSiguiente, onError, onCompletion) Adjunta un detector para eventos QuerySnapshot . Puede pasar devoluciones de llamada onNext y onError individuales o pasar un único objeto observador con devoluciones de llamada next y error . El oyente se puede cancelar llamando a la función que se devuelve cuando se llama a onSnapshot . NOTA: Aunque se puede proporcionar una devolución de llamada onCompletion , nunca se llamará porque la secuencia de instantáneas es interminable.
onSnapshot(consulta, opciones, onNext, onError, onCompletion) Adjunta un detector para eventos QuerySnapshot . Puede pasar devoluciones de llamada onNext y onError individuales o pasar un único objeto observador con devoluciones de llamada next y error . El oyente se puede cancelar llamando a la función que se devuelve cuando se llama a onSnapshot . NOTA: Aunque se puede proporcionar una devolución de llamada onCompletion , nunca se llamará porque la secuencia de instantáneas es interminable.
consulta (consulta, filtro compuesto, restricciones de consulta) Crea una nueva instancia inmutable de Query que se extiende para incluir también restricciones de consulta adicionales.
consulta (consulta, consultaRestricciones) Crea una nueva instancia inmutable de Query que se extiende para incluir también restricciones de consulta adicionales.
función (consultaConstraints, ...)
y (restricciones de consulta) Crea una nueva QueryCompositeFilterConstraint que es una conjunción de las restricciones de filtro dadas. Un filtro de conjunción incluye un documento si satisface todos los filtros dados.
o (consultaRestricciones) Crea una nueva QueryCompositeFilterConstraint que es una disyunción de las restricciones de filtro dadas. Un filtro de disyunción incluye un documento si satisface alguno de los filtros dados.
función(referencia, ...)
addDoc(referencia, datos) Agregue un nuevo documento a CollectionReference especificada con los datos proporcionados, asignándole un ID de documento automáticamente.
colección (referencia, ruta, segmentos de ruta) Obtiene una instancia CollectionReference que hace referencia a una subcolección de reference en la ruta relativa especificada.
colección (referencia, ruta, segmentos de ruta) Obtiene una instancia CollectionReference que hace referencia a una subcolección de reference en la ruta relativa especificada.
eliminarDoc(referencia) Elimina el documento al que hace referencia la DocumentReference especificada.
doc(referencia, ruta, segmentos de ruta) Obtiene una instancia DocumentReference que hace referencia a un documento dentro de la reference en la ruta relativa especificada. Si no se especifica ninguna ruta, se utilizará una ID única generada automáticamente para la DocumentReference devuelta.
doc(referencia, ruta, segmentos de ruta) Obtiene una instancia DocumentReference que hace referencia a un documento dentro de la reference en la ruta relativa especificada.
getDoc(referencia) Lee el documento al que hace referencia este DocumentReference . Nota: getDoc() intenta proporcionar datos actualizados cuando es posible esperando datos del servidor, pero puede devolver datos almacenados en caché o fallar si no está conectado y no se puede acceder al servidor. Para especificar este comportamiento, invoque getDocFromCache() o getDocFromServer() .
getDocFromCache (referencia) Lee el documento al que hace referencia esta DocumentReference desde la memoria caché. Devuelve un error si el documento no está actualmente en caché.
getDocFromServer (referencia) Lee el documento al que hace referencia este DocumentReference desde el servidor. Devuelve un error si la red no está disponible.
onSnapshot (referencia, observador) Adjunta un detector para eventos DocumentSnapshot . Puede pasar devoluciones de llamada onNext y onError individuales o pasar un único objeto observador con devoluciones de llamada next y error . NOTA: Aunque se puede proporcionar una devolución de llamada onCompletion , nunca se llamará porque la secuencia de instantáneas es interminable.
onSnapshot(referencia, opciones, observador) Adjunta un detector para eventos DocumentSnapshot . Puede pasar devoluciones de llamada onNext y onError individuales o pasar un único objeto observador con devoluciones de llamada next y error . NOTA: Aunque se puede proporcionar una devolución de llamada onCompletion , nunca se llamará porque la secuencia de instantáneas es interminable.
onSnapshot(referencia, onNext, onError, onCompletion) Adjunta un detector para eventos DocumentSnapshot . Puede pasar devoluciones de llamada onNext y onError individuales o pasar un único objeto observador con devoluciones de llamada next y error . NOTA: Aunque se puede proporcionar una devolución de llamada onCompletion , nunca se llamará porque la secuencia de instantáneas es interminable.
onSnapshot(referencia, opciones, onNext, onError, onCompletion) Adjunta un detector para eventos DocumentSnapshot . Puede pasar devoluciones de llamada onNext y onError individuales o pasar un único objeto observador con devoluciones de llamada next y error . NOTA: Aunque se puede proporcionar una devolución de llamada onCompletion , nunca se llamará porque la secuencia de instantáneas es interminable.
setDoc(referencia, datos) Escribe en el documento al que hace referencia este DocumentReference . Si el documento aún no existe, se creará.
setDoc(referencia, datos, opciones) Escribe en el documento al que hace referencia la DocumentReference especificada. Si el documento aún no existe, se creará. Si proporciona merge o mergeFields , los datos proporcionados se pueden combinar en un documento existente.
updateDoc(referencia, datos) Actualiza los campos del documento al que hace referencia la DocumentReference especificada. La actualización fallará si se aplica a un documento que no existe.
updateDoc(referencia, campo, valor, másCamposAndValues) Actualiza los campos en el documento al que hace referencia la DocumentReference especificada. La actualización fallará si se aplica a un documento que no existe. Los campos anidados se pueden actualizar proporcionando cadenas de ruta de campo separadas por puntos o proporcionando objetos FieldPath .
función (configuración, ...)
memoriaLocalCache(configuración) Crea una instancia de MemoryLocalCache . La instancia se puede configurar en FirestoreSettings.cache para indicarle al SDK qué capa de caché usar.
memoriaLruGarbageCollector(configuración) Crea una instancia de MemoryLruGarbageCollector . Se puede especificar un tamaño de destino como parte del parámetro de configuración. El recopilador comenzará a eliminar documentos una vez que el tamaño de la caché supere el tamaño especificado. El tamaño de caché predeterminado es 40 MB (40 * 1024 * 1024 bytes).
persistenteLocalCache(configuración) Crea una instancia de PersistentLocalCache . La instancia se puede configurar en FirestoreSettings.cache para indicarle al SDK qué capa de caché usar. La caché persistente no se puede utilizar en un entorno Node.js.
persistenteSingleTabManager (configuración) Crea una instancia de PersistentSingleTabManager .
función (instantánea, ...)
finalizar en (instantánea) Crea un QueryEndAtConstraint que modifica el conjunto de resultados para que finalice en el documento proporcionado (inclusive). La posición final es relativa al orden de la consulta. El documento debe contener todos los campos proporcionados en el ordenPor de la consulta.
finalizar antes (instantánea) Crea un QueryEndAtConstraint que modifica el conjunto de resultados para que finalice antes del documento proporcionado (exclusivo). La posición final es relativa al orden de la consulta. El documento debe contener todos los campos proporcionados en el ordenPor de la consulta.
empezar después (instantánea) Crea un QueryStartAtConstraint que modifica el conjunto de resultados para que comience después del documento proporcionado (exclusivo). La posición inicial es relativa al orden de la consulta. El documento debe contener todos los campos proporcionados en el ordenPor de la consulta.
inicio en (instantánea) Crea un QueryStartAtConstraint que modifica el conjunto de resultados para comenzar en el documento proporcionado (inclusive). La posición inicial es relativa al orden de la consulta. El documento debe contener todos los campos proporcionados en el orderBy de esta consulta.

Clases

Clase Descripción
Campo agregado Representa una agregación que puede realizar Firestore.
Instantánea de consulta agregada Los resultados de la ejecución de una consulta de agregación.
bytes Un objeto inmutable que representa una matriz de bytes.
ColecciónReferencia Se puede utilizar un objeto CollectionReference para agregar documentos, obtener referencias de documentos y consultar documentos (usando query() ).
Referencia de documento Una DocumentReference se refiere a la ubicación de un documento en una base de datos de Firestore y se puede usar para escribir, leer o escuchar la ubicación. El documento en la ubicación referenciada puede existir o no.
Instantánea del documento Un DocumentSnapshot contiene datos leídos de un documento en su base de datos de Firestore. Los datos se pueden extraer con .data() o .get(<field>) para obtener un campo específico. Para una DocumentSnapshot que apunta a un documento no existente, cualquier acceso a datos devolverá "indefinido". Puede utilizar el método exists() para verificar explícitamente la existencia de un documento.
Ruta de campo Un FieldPath se refiere a un campo en un documento. La ruta puede consistir en un único nombre de campo (que hace referencia a un campo de nivel superior en el documento) o una lista de nombres de campos (que hace referencia a un campo anidado en el documento). Cree un FieldPath proporcionando nombres de campos. Si se proporciona más de un nombre de campo, la ruta apuntará a un campo anidado en un documento.
Valor de campo Valores centinela que se pueden utilizar al escribir campos de documentos con set() o update() .
Tienda de fuego La interfaz del servicio Cloud Firestore. No llame a este constructor directamente. En su lugar, utilice getFirestore() .
Error de tienda de fuego Un error devuelto por una operación de Firestore.
Geopunto Un objeto inmutable que representa una ubicación geográfica en Firestore. La ubicación se representa como un par de latitud/longitud. Los valores de latitud están en el rango de [-90, 90]. Los valores de longitud están en el rango de [-180, 180].
Tarea de paquete de carga Representa la tarea de cargar un paquete de Firestore. Proporciona el progreso de la carga del paquete, así como la finalización de tareas y eventos de error. La API es compatible con Promise<LoadBundleTaskProgress> .
Administrador de índice de caché persistente Un PersistentCacheIndexManager para configurar índices de caché persistentes utilizados para la ejecución de consultas locales. Para usarlo, llame getPersistentCacheIndexManager() para obtener una instancia.
Consulta Una Query se refiere a una consulta que puede leer o escuchar. También puede construir objetos Query refinados agregando filtros y ordenándolos.
QueryCompositeFilterConstraint Se utiliza un QueryCompositeFilterConstraint para limitar el conjunto de documentos devueltos por una consulta de Firestore realizando el OR o el AND lógico de múltiples QueryFieldFilterConstraint . s o QueryCompositeFilterConstraint s. QueryCompositeFilterConstraint se crean invocando or() o and() y luego se pueden pasar a query() para crear una nueva instancia de consulta que también contenga QueryCompositeFilterConstraint .
Restricción de consulta Se utiliza una QueryConstraint para limitar el conjunto de documentos devueltos por una consulta de Firestore. Los QueryConstraint se crean invocando dónde() , ordenar por() , Empieza en() , empezar después() , finalizar antes() , termina en() , límite() , limitToLast() y luego se puede pasar a query() para crear una nueva instancia de consulta que también contenga este QueryConstraint .
ConsultaDocumentoInstantánea Un QueryDocumentSnapshot contiene datos leídos de un documento en su base de datos de Firestore como parte de una consulta. Se garantiza que el documento existe y sus datos se pueden extraer con .data() o .get(<field>) para obtener un campo específico. Un QueryDocumentSnapshot ofrece la misma superficie API que un DocumentSnapshot . Dado que los resultados de la consulta solo contienen documentos existentes, la propiedad exists siempre será verdadera y data() nunca devolverá "indefinido".
QueryEndAtConstraint Se utiliza QueryEndAtConstraint para excluir documentos del final de un conjunto de resultados devuelto por una consulta de Firestore. QueryEndAtConstraint se crean invocando endAt() o endBefore() y luego se pueden pasar a query() para crear una nueva instancia de consulta que también contenga este QueryEndAtConstraint .
Restricción de filtro de campo de consulta Un QueryFieldFilterConstraint se utiliza para limitar el conjunto de documentos devueltos por una consulta de Firestore filtrando uno o más campos de documento. QueryFieldFilterConstraint se crean invocando where() y luego se pueden pasar a query() para crear una nueva instancia de consulta que también contenga este QueryFieldFilterConstraint .
Restricción de límite de consulta Se utiliza un QueryLimitConstraint para limitar la cantidad de documentos devueltos por una consulta de Firestore. QueryLimitConstraint se crean invocando limit() o limitToLast() y luego se pueden pasar a query() para crear una nueva instancia de consulta que también contenga este QueryLimitConstraint .
ConsultaOrderByConstraint Se utiliza QueryOrderByConstraint para ordenar el conjunto de documentos devueltos por una consulta de Firestore. QueryOrderByConstraint se crean invocando orderBy() y luego se pueden pasar a query() para crear una nueva instancia de consulta que también contenga este QueryOrderByConstraint . Nota: Los documentos que no contengan el campo ordenarPor no estarán presentes en el resultado de la consulta.
ConsultaInstantánea Un QuerySnapshot contiene cero o más objetos DocumentSnapshot que representan los resultados de una consulta. Se puede acceder a los documentos como una matriz a través de la propiedad docs o enumerarlos usando el método forEach . El número de documentos se puede determinar mediante las propiedades empty y size .
ConsultaInicioEnConstraint Se utiliza QueryStartAtConstraint para excluir documentos del inicio de un conjunto de resultados devuelto por una consulta de Firestore. QueryStartAtConstraint se crean invocando startAt() o startAfter() y luego se pueden pasar a query() para crear una nueva instancia de consulta que también contenga este QueryStartAtConstraint .
InstantáneaMetadatos Metadatos sobre una instantánea, que describen el estado de la instantánea.
Marca de tiempo Una Timestamp representa un punto en el tiempo independiente de cualquier zona horaria o calendario, representado como segundos y fracciones de segundos con una resolución de nanosegundos en la época UTC. Está codificado utilizando el Calendario Gregoriano Proléptico que extiende el calendario gregoriano hacia atrás hasta el año uno. Se codifica asumiendo que todos los minutos tienen una duración de 60 segundos, es decir, los segundos intercalares están "borrados" de modo que no se necesita una tabla de segundos intercalares para la interpretación. El rango es de 0001-01-01T00:00:00Z a 9999-12-31T23:59:59.999999999Z. Para obtener ejemplos y especificaciones adicionales, consulte la definición de marca de tiempo. .
Transacción Una referencia a una transacción. El objeto Transaction pasado a updateFunction de una transacción proporciona los métodos para leer y escribir datos dentro del contexto de la transacción. Ver ejecutarTransacción() .
escribir lote Un lote de escritura, utilizado para realizar múltiples escrituras como una sola unidad atómica. Se puede adquirir un objeto WriteBatch llamando a writeBatch() . Proporciona métodos para agregar escrituras al lote de escritura. Ninguna de las escrituras será cometida (o visible localmente) hasta que se llame WriteBatch.commit () .

Interfaces

Interfaz Descripción
Especificaciones agregadas Especifica un conjunto de agregaciones y sus alias.
Cambio de documento Un DocumentChange representa un cambio en los documentos que coinciden con una consulta. Contiene el documento afectado y el tipo de cambio ocurrido.
Datos del documento Documentos de documentos (para usar con setDoc () ) consiste en campos asignados a valores.
ExperimentallongpollingOptions Opciones que configuran el transporte de red subyacente del SDK (WebChannel) cuando se usa de cola larga. Nota: Esta interfaz es "experimental" y está sujeta a cambios. Ver FirestoreSettings.experimentalAutoDetectLongPolling , FirestoreSettings.experimentalForceLongPolling Experimental ConcelongPolling y FirestoreSettings.experimentalLongPollingOptions .
FirestoredAconverter Converter utilizado por withConverter() para transformar los objetos de usuario de tipo AppModelType en datos de Firestore del tipo DbModelType . El uso del convertidor le permite especificar argumentos de tipo genérico al almacenar y recuperar objetos de Firestore. En este contexto, un "AppModel" es una clase que se utiliza en una aplicación para empacar información y funcionalidad relacionadas. Dicha clase podría, por ejemplo, tener propiedades con tipos de datos complejos, anidados, propiedades utilizadas para la memorización, las propiedades de los tipos no compatibles con Firestore (como symbol y bigint ) y funciones auxiliares que realizan operaciones compuestas. Dichas clases no son adecuadas y/o posibles para almacenar en una base de datos Firestore. En cambio, las instancias de tales clases deben convertirse en "objetos JavaScript antiguos" (POJOS) con propiedades exclusivamente primitivas, potencialmente anidadas dentro de otros Pojos o matrices de Pojos. En este contexto, este tipo se conoce como "DBModel" y sería un objeto adecuado para persistir en Firestore. Por conveniencia, las aplicaciones pueden implementar FirestoreDataConverter y registrar el convertidor con objetos de Firestore, como DocumentReference o Query , para convertir automáticamente AppModel a DbModel al almacenar en Firestore, y convertir DbModel a AppModel cuando se recupere de Firestore.
Configuración de Firestore Especifica configuraciones personalizadas para su instancia de Cloud Firestore. Debe configurarlos antes de invocar cualquier otro método.
Índice (Beta) La definición SDK de un índice Firestore.
Configuración de índice (Beta) Una lista de índices de Firestore para acelerar la ejecución de la consulta local. Consulte el formato JSON para una descripción del formato de la definición del índice.
Campo de índice (Beta) Un solo elemento de campo en una configuración de índice.
CargarBundleTaskProgress Representa una actualización de progreso o un estado final de la carga de paquetes.
Configuración de memoria caché Un objeto de configuración para configurar una instancia MemoryLocalCache .
MemoryEagerGageCollector Un recolector de basura elimina documentos cada vez que no forman parte de ninguna consulta activa, y no tienen mutaciones locales adjuntas a ellas. Este coleccionista intenta garantizar las huellas de memoria más bajas del SDK, a riesgo de que los documentos no se almacenen en caché para consultas fuera de línea o para consultas directas al caché. Use la función de fábrica para crear una instancia de este coleccionista.
MemoryLocalCache Proporciona un caché en memoria al SDK. Este es el caché predeterminado a menos que se configure explícitamente lo contrario. Para usar, cree una instancia usando la función de fábrica, luego establezca la instancia en FirestoreSettings.cache y llame a initializeFirestore usando el objeto Configuración.
MemoryLrugarGageCollector Un recolector de basura elimina documentos de menos recursos en múltiples lotes. Este coleccionista está configurado con un tamaño de destino y solo realizará la colección cuando los documentos en caché excedan el tamaño de destino. Evita la consulta del backend repetido para la misma consulta o documento, a riesgo de tener una huella de memoria más grande. Use la función de fábrica para crear una instancia de este coleccionista.
Persistences Stettings Configuración que se puede pasar a enableIndexedDbPersistence() para configurar la persistencia de Firestore. La persistencia no puede usarse en un entorno nodo.js.
Configuración de caché persistente Un objeto de configuración para configurar una instancia PersistentLocalCache . El caché persistente no se puede usar en un entorno nodo.js.
PersistentLocalcache Proporciona un caché persistente respaldado por indexedDB al SDK. Para usar, cree una instancia usando la función de fábrica, luego establezca la instancia en FirestoreSettings.cache y llame a initializeFirestore usando el objeto Configuración.
PersistentMultIPletAbmanager Un administrador de pestañas que admite múltiples pestañas. SDK sincronizará consultas y mutaciones realizadas en todas las pestañas utilizando el SDK.
Persistentsingletabmanager Un administrador de pestañas que admite solo una pestaña, no se realizará sincronización en las pestañas.
Persistentsingletabmanagersettings Escriba para configurar una instancia PersistentSingleTabManager .
InstantáneaEscucharOpciones Un objeto de opciones que se puede pasar a OnsnapShot () y QuerySnapShot.docchanges () para controlar qué tipos de cambios se incluyen en el conjunto de resultados.
Opciones de instantánea Opciones que configuran cómo se recuperan los datos de un DocumentSnapshot (por ejemplo, el comportamiento deseado para las marcas de tiempo del servidor que aún no se han establecido en su valor final).
Opciones de transacción Opciones para personalizar el comportamiento de la transacción.
Darse de baja Una función devuelta por onSnapshot() que elimina al oyente cuando se invoca.

variables

Variable Descripción
Cache_size_unlimited Constante utilizada para indicar la recolección de basura LRU debe deshabilitarse. Establezca este valor como cacheSizeBytes en la configuración pasada a la instancia de Firestore .

Tipo de alias

Tipo Alias Descripción
AddprefyteCkokeys Devuelve un nuevo mapa donde cada clave tiene el prefijo con la tecla externa adjunta a un punto.
Tipo de campo agregado La unión de todos los tipos AggregateField admitidos por Firestore.
Datos de especificación agregados Un tipo cuyas claves se toman de AggregateSpec y cuyos valores son el resultado de la agregación realizada por el AggregateField correspondiente a partir de la entrada AggregateSpec .
AgregateType Tipo de unión que representa el tipo agregado a realizar.
Childupdatefields Ayudante para calcular los campos anidados para un tipo dado T1. Esto es necesario para distribuir tipos de sindicatos como undefined | {...} (sucede para accesorios opcionales) o {a: A} | {b: B} . En este caso de uso, V se usa para distribuir los tipos de unión de T[K] Record , ya que T[K] se evalúa como una expresión y no se distribuye. Ver https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-condicional-types
Tipo de cambio de documento El tipo de DocumentChange puede ser "agregado", "eliminado" o "modificado".
FirestoreErrorCode El conjunto de códigos de estado de Firestore. Los códigos son los mismos en los expuestos por GRPC aquí: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md Valores posibles: - 'cancelado': la operación fue cancelada (generalmente por la persona que llama). - 'Desconocido': error desconocido o un error de un dominio de error diferente. - 'Argumento no válido': el cliente especificó un argumento no válido. Tenga en cuenta que esto difiere de la "precondición fallida". El "argumento no válido" indica argumentos que son problemáticos independientemente del estado del sistema (por ejemplo, un nombre de campo no válido). - 'Proporcionado con la fecha límite': la fecha límite expiró antes de que la operación pudiera completarse. Para operaciones que cambian el estado del sistema, este error puede aparecer incluso si la operación se completó exitosamente. Por ejemplo, una respuesta exitosa de un servidor podría haberse retrasado lo suficiente como para que expirara el plazo. - 'No se encontró': no ​​se encontró algún documento solicitado. - 'ya existe': algún documento que intentamos crear ya existe. - 'Renado por permiso': la persona que llama no tiene permiso para ejecutar la operación especificada. -'recursos exhaustados': algunos recursos se han agotado, tal vez una cuota por usuario, o tal vez todo el sistema de archivos está fuera de espacio. - 'Precondición fallida': la operación fue rechazada porque el sistema no está en un estado requerido para la ejecución de la operación. - 'abortado': la operación fue abortada, generalmente debido a un problema de concurrencia como los abortos de transacción, etc.- 'fuera de rango': la operación se intentó más allá del rango válido. - 'no implementado': la operación no se implementa o no es compatible/habilitada. - 'interno': errores internos. Significa que se han roto algunas invariantes esperadas por el sistema subyacente. Si ve uno de estos errores, algo está muy roto. - 'no disponible': el servicio no está disponible actualmente. Es muy probable que sea una condición transitoria y pueda corregirse reintando con un retroceso. - 'La pérdida de datos': pérdida de datos o corrupción irrecuperables. - 'no autenticado': la solicitud no tiene credenciales de autenticación válidas para la operación.
FirestorElocalcache Tipo de unión de toda la capa de caché SDK compatible.
Oquilar Describa la fuente que escucha una consulta. Establecer en default para escuchar los cambios de caché y servidor. Establecer en cache para escuchar los cambios solo en caché.
MemorygarGageCollector Tipo de unión de todos los coleccionistas de Gabage de soporte para la memoria caché local.
Nestedupdatefields Para cada campo (por ejemplo, 'bar'), encuentre todas las claves anidadas (por ejemplo, { 'Bar.Baz': T1, 'Bar.qux': T2 } ). Intersectlos juntos para hacer un solo mapa que contenga todas las teclas posibles que están marcadas como opcionales
OrderByDirection La dirección de una cláusula Orderby () se especifica como 'DESC' o 'ASC' (descendente o ascendente).
Parcialwithfieldvalue Similar a Partial<T> de TypeScript, pero permite que los campos anidados se omitan y los valores de campo sean pasados ​​como valores de propiedad.
PersistentTabmanager Una unión de todos los gerentes de pestañas disponibles.
Primitivo Tipos primitivos.
Consultyconstrainttype Describe las diferentes restricciones de consulta disponibles en este SDK.
Restricción de filtro de consulta QueryFilterConstraint es un tipo de unión auxiliar que representa QueryFieldFilterConstraint y QueryCompositeFilterConstraint .
Consulta QueryNonFilterConstraint es un tipo de unión auxiliar que representa la consulta de consultas que se utilizan para reducir o ordenar el conjunto de documentos, pero que no se filtran explícitamente en un campo de documento. QueryNonFilterConstraint S se crean invocando Orderby () , Empieza en() , startafter () , endbefore () , termina en() , Limit () o Limittolast () y luego se puede pasar a la consulta () para crear una nueva instancia de consulta que también contenga la QueryConstraint .
Establecer opciones Un objeto de opciones que configura el comportamiento de setDoc () , y llamadas. Estas llamadas se pueden configurar para realizar fusiones granulares en lugar de sobrescribir los documentos de destino en su totalidad proporcionando SetOptions con merge: true .
Estado de tarea Representa el estado de las tareas de carga de paquetes. Tanto el 'error' como el 'éxito' están hundiendo el estado: la tarea abortará o se completará y no habrá más actualizaciones después de que se informen.
unión a la intersección Dado un tipo de unión U = T1 | T2 | ... , devuelve un tipo intersectado (T1 & T2 & ...) . Utiliza tipos condicionales distributivos e inferencia de tipos condicionales. Esto funciona porque múltiples candidatos para la misma variable de tipo en posiciones contrahariantes hace que se infiera un tipo de intersección. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-condicional-types https://stackoverflow.com/Questions/50374908/transform-union-type-ing-inger -tipo
Actualizar datos Actualizar datos (para usar con actualateC () ) que consiste en rutas de campo (por ejemplo, 'foo' o 'foo.baz') asignadas a valores. Los campos que contienen puntos de referencia a los campos anidados dentro del documento. Los valores de campo se pueden pasar como valores de propiedad.
DondeFilterOp Las condiciones del filtro en una cláusula donde () se especifican utilizando las cadenas '& lt;', '& lt; =', '==', '! =', '& Gt; =', '& gt;', 'Array-Contains' , 'en', 'Array-Contains-Anhy' y 'Not-In'.
WithfieldValue Permite que los valores de campo se pasen como valor de propiedad mientras se mantiene la seguridad del tipo.

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

getFirestore (aplicación)

Devuelve la instancia de Firestore predeterminada existente que está asociada con el FirebaseApp proporcionado . Si no existe ninguna instancia, inicializa una nueva instancia con la configuración predeterminada.

Firma:

export declare function getFirestore(app: FirebaseApp): Firestore;

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase La instancia de FirebaseApp con la que se asocia la instancia de Firestore devuelta.

Devoluciones:

Tienda de fuego

La instancia predeterminada de Firestore de la aplicación proporcionada.

getFirestore (aplicación, base de datos)

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No use esta API en un entorno de producción.

Devuelve la instancia existente llamada Firestore que está asociada con el FirebaseApp proporcionado . Si no existe ninguna instancia, inicializa una nueva instancia con la configuración predeterminada.

Firma:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase La instancia de FirebaseApp con la que se asocia la instancia de Firestore devuelta.
base de datos cadena El nombre de la base de datos.

Devoluciones:

Tienda de fuego

La instancia de Firestore nombrada de la aplicación proporcionada.

InitializeFirestore (aplicación, configuración, base de datos)

Inicializa una nueva instancia de Firestore con la configuración proporcionada. Solo se puede llamar antes de cualquier otra función, incluido getFirestore () . Si la configuración personalizada está vacía, esta función es equivalente a llamar a getFirestore () .

Firma:

export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase El FirebaseApp con el que se asociará la instancia de Firestore .
ajustes Configuración de Firestore Un objeto de configuración para configurar la instancia de Firestore .
base de datos cadena El nombre de la base de datos.

Devoluciones:

Tienda de fuego

Una instancia de Firestore recientemente inicializada.

función (Firestore, ...)

ClearIndexedDBpersistence (Firestore)

Borra el almacenamiento persistente. Esto incluye escrituras pendientes y documentos en caché.

Debe llamarse mientras no se inicia la instancia de Firestore (después de que se termina la aplicación o cuando la aplicación se inicializa por primera vez). Al inicio, esta función debe llamarse antes de otras funciones (que no sean InitializeFireStore () o getFirestore () )). Si la instancia de Firestore todavía se está ejecutando, la promesa será rechazada con el código de error de failed-precondition .

Firma:

export declare function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia de Firestore para eliminar la persistencia.

Devoluciones:

Promesa<nulo>

Una Promise que se resuelve cuando se borra el almacenamiento persistente. De lo contrario, la promesa se rechaza con un error.

Colección (Firestore, Path, PathSegments)

Obtiene una instancia CollectionReference que se refiere a la colección en la ruta absoluta especificada.

Firma:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego Una referencia a la instancia de Root Firestore .
camino cadena Un camino separado por barras a una colección.
segmentos de ruta cadena[] Segmentos de ruta adicionales para aplicar en relación con el primer argumento.

Devoluciones:

ColecciónReferencia < DocumentData , DocumentData >

La instancia CollectionReference .

Excepciones

Si la ruta final tiene un número par de segmentos y no apunta a una colección.

CollectionGroup (Firestore, CollectionID)

Crea y devuelve una nueva instancia Query que incluye todos los documentos en la base de datos que están contenidas en una colección o subcolección con el collectionId dado .

Firma:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego Una referencia a la instancia de Root Firestore .
ID de colección cadena Identifica las colecciones para consultar. Se incluirá cada colección o subcolección con esta ID como último segmento de su camino. No puede contener una barra.

Devoluciones:

Consulta < DocumentData , DocumentData >

La Query creada .

ConnectFirestoreemulator (Firestore, Host, Port, Opciones)

Modifique esta instancia para comunicarse con el emulador Cloud Firestore.

Firma:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia Firestore para configurar para conectarse al emulador.
anfitrión cadena El host del emulador (ex: localhost).
puerto número El puerto del emulador (Ej: 9000).
opciones {MockuserToken?: EmulatorMockTokenOptions | cadena; }

Devoluciones:

vacío

discaplenetwork (Firestore)

Desactiva el uso de la red para esta instancia. Se puede volver a habilitar a través de EnableNetwork () . Si bien la red está deshabilitada, cualquier oyente de instantánea, llamadas getDoc() o getDocs() devolverá los resultados de la caché, y cualquier operación de escritura se colocará hasta que se restablezca la red.

Firma:

export declare function disableNetwork(firestore: Firestore): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego

Devoluciones:

Promesa<nulo>

Una Promise que se resuelve una vez que la red ha sido deshabilitada.

Doc (Firestore, Path, PathSegments)

Obtiene una instancia DocumentReference que se refiere al documento en la ruta absoluta especificada.

Firma:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego Una referencia a la instancia de Root Firestore .
camino cadena Un camino separado por barras a un documento.
segmentos de ruta cadena[] Segmentos de ruta adicionales que se aplicarán en relación con el primer argumento.

Devoluciones:

Referencia de documento < DocumentData , DocumentData >

La instancia DocumentReference .

Excepciones

Si la ruta final tiene un número impar de segmentos y no apunta a un documento.

habilitarindexeddbpersistence (Firestore, Persistencesettings)

Esta función se eliminará en un lanzamiento importante futuro. En su lugar, configure FirestoreSettings.localCache en una instancia de PersistentLocalCache para encender el caché indexadoDDB. Llamar a esta función cuando FirestoreSettings.localCache ya está especificado que lanzará una excepción.

Intentos de habilitar el almacenamiento persistente, si es posible.

Al fallar, enableIndexedDbPersistence() rechazará la promesa o lanzará una excepción. Hay varias razones por las cuales esto puede fallar, que puede ser identificado por el code en el error.

* Precondición fallida: la aplicación ya está abierta en otra pestaña del navegador. * No implementado: el navegador es incompatible con la implementación de persistencia fuera de línea.

Tenga en cuenta que incluso después de una falla, la instancia de Firestore seguirá siendo utilizable, sin embargo, la persistencia fuera de línea se deshabilitará.

La persistencia no puede usarse en un entorno nodo.js.

Firma:

export declare function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia de Firestore para habilitar la persistencia para.
Persistences Stettings Persistences Stettings Configuración opcional Objeto para configurar la persistencia.

Devoluciones:

Promesa<nulo>

Una Promise que representa con éxito el almacenamiento persistente con éxito.

EnableMultitabIndexedDBpersistence (Firestore)

Esta función se eliminará en un lanzamiento importante futuro. En su lugar, configure FirestoreSettings.localCache en una instancia de PersistentLocalCache para encender el caché indexadoDDB. Llamar a esta función cuando FirestoreSettings.localCache ya está especificado que lanzará una excepción.

Intentos de habilitar el almacenamiento persistente de múltiples tasiones, si es posible. Si está habilitado en todas las pestañas, todas las operaciones comparten acceso a la persistencia local, incluida la ejecución compartida de consultas y actualizaciones de documentos locales compensadas por latencia en todas las instancias conectadas.

Al fallar, enableMultiTabIndexedDbPersistence() rechazará la promesa o lanzará una excepción. Hay varias razones por las cuales esto puede fallar, que puede ser identificado por el code en el error.

* PROCONDICIÓN FALLAR: La aplicación ya está abierta en otra pestaña del navegador y no está habilitado múltiples tasiones. * No implementado: el navegador es incompatible con la implementación de persistencia fuera de línea.

Tenga en cuenta que incluso después de una falla, la instancia de Firestore seguirá siendo utilizable, sin embargo, la persistencia fuera de línea se deshabilitará.

Firma:

export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia de Firestore para habilitar la persistencia para.

Devoluciones:

Promesa<nulo>

Una Promise que representa con éxito el almacenamiento persistente con éxito.

Enablenetwork (Firestore)

Vuelva a rehacer el uso de la red para esta instancia de Firestore después de una llamada previa a discaplenetwork () .

Firma:

export declare function enableNetwork(firestore: Firestore): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego

Devoluciones:

Promesa<nulo>

Una Promise que se resuelve una vez que la red ha sido habilitada.

getPersistentCacheIndexManager (Firestore)

Devuelve el Administrador del índice PersistentCache utilizado por el objeto Firestore dado.

La instancia PersistentCacheIndexManager , o null si el almacenamiento persistente local no está en uso.

Firma:

export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego

Devoluciones:

PersistentCacheIndexManager | nulo

LoadBundle (Firestore, Bundledata)

Carga un paquete de Firestore en el caché local.

Firma:

export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia de Firestore para cargar paquetes para.
bundlledata ReadAblEstream <Uint8Array> | búfer de matriz | cadena Un objeto que representa el paquete a cargar. Los objetos válidos son ArrayBuffer , ReadableStream<Uint8Array> o string .

Devoluciones:

Tarea de paquete de carga

Un objeto LoadBundleTask , que notifica a las personas que llaman con actualizaciones de progreso y eventos de finalización o error. Se puede usar como una Promise<LoadBundleTaskProgress> .

NamedQuery (Firestore, nombre)

Lee una consulta de Firestore de la caché local, identificada por el nombre de pila.

Las consultas con nombre se empaquetan en paquetes en el lado del servidor (junto con los documentos resultantes), y se cargan a la memoria caché local usando loadBundle . Una vez en el caché local, use este método para extraer una consulta por nombre.

Firma:

export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia de Firestore para leer la consulta de.
nombre cadena El nombre de la consulta.

Devoluciones:

Promise < Query | nulo>

Una Promise que se resuelve con la consulta o null .

OnsnapshotsinSync (Firestore, Observer)

Adjunta un oyente para un evento de instantáneas en sincronización. El evento de instantáneas en sincronización indica que todos los oyentes afectados por un cambio dado han disparado, incluso si un solo cambio generado por servidor afecta a múltiples oyentes.

Nota: El evento de instantáneas en sincronización solo indica que los oyentes están sincronizados entre sí, pero no se relacionan con si esas instantáneas están sincronizadas con el servidor. Use SnapShotMetadata en los oyentes individuales para determinar si una instantánea es de la memoria caché o del servidor.

Firma:

export declare function onSnapshotsInSync(firestore: Firestore, observer: {
    next?: (value: void) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia de Firestore para sincronizar instantáneas.
observador {siguiente?: (valor: void) => void; ¿Error?: (Error: FirestoreError ) => void; completo ?: () => void; } Un solo objeto que contiene devoluciones de llamada next y error .

Devoluciones:

Darse de baja

Una función de cancelación de suscripción que se puede llamar para cancelar el oyente de las instantáneas.

OnsnapshotsinSync (Firestore, Onsync)

Adjunta un oyente para un evento de instantáneas en sincronización. El evento de instantáneas en sincronización indica que todos los oyentes afectados por un cambio dado han disparado, incluso si un solo cambio generado por servidor afecta a múltiples oyentes.

Nota: El evento de instantáneas en sincronización solo indica que los oyentes están sincronizados entre sí, pero no se relacionan con si esas instantáneas están sincronizadas con el servidor. Use SnapshotMetadata en los oyentes individuales para determinar si una instantánea es de la memoria caché o del servidor.

Firma:

export declare function onSnapshotsInSync(firestore: Firestore, onSync: () => void): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia Firestore para sincronizar instantáneas.
en sincronización () => nulo Una devolución de llamada para llamar cada vez que todos los oyentes de instantáneas están sincronizados entre sí.

Devoluciones:

Darse de baja

Una función de cancelación de suscripción que se puede llamar para cancelar el oyente de las instantáneas.

Runtransaction (Firestore, UpdateFunction, Opciones)

Ejecuta la updateFunction dada e intenta confirmar los cambios aplicados dentro de la transacción. Si algún documento leída dentro de la transacción ha cambiado, Cloud Firestore reemplaza la updateFunction . Si no se compromete después de 5 intentos, la transacción falla.

El número máximo de escrituras permitidas en una sola transacción es 500.

Firma:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego Una referencia a la base de datos Firestore para ejecutar esta transacción.
función de actualización (Transacción: transacción ) => Promesa <t> La función para ejecutar dentro del contexto de transacción.
opciones Opciones de transacción Un objeto de opciones para configurar el número máximo de intentos de comprometerse.

Devoluciones:

Promesa <T>

Si la transacción se completó con éxito o se abortó explícitamente (la updateFunction devolvió una promesa fallida), la promesa devuelta por la updateFunction se devuelve aquí. De lo contrario, si la transacción falló, se devuelve una promesa rechazada con el error de falla correspondiente.

SetIndexConfiguration (Firestore, Configuración)

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No use esta API en un entorno de producción.

En lugar de crear índices de caché manualmente, considere usar enablePersistentCacheIndexAutoCreation() para permitir que el SDK decida si crear índices de caché para consultas que se ejecutan localmente.

Configura la indexación para la ejecución de consultas locales. Cualquier configuración de índice anterior se anula. La Promise se resuelve una vez que se ha persistido la configuración del índice.

Las entradas de índice en sí se crean asincrónicamente. Puede continuar utilizando consultas que requieren indexación incluso si los índices aún no están disponibles. La ejecución de la consulta comenzará automáticamente a usar el índice una vez que se hayan escrito las entradas de índice.

Los índices solo son compatibles con la persistencia indexedDB. Si IndexedDB no está habilitado, se ignora cualquier configuración de índice.

Firma:

export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia de Firestore para configurar índices para.
configuración Configuración de índice La definición del índice.

Devoluciones:

Promesa<nulo>

Una Promise que se resuelve una vez que todos los índices se configuran con éxito.

Excepciones

FirestoreError si el formato JSON no es válido.

SetIndexConfiguration (Firestore, JSON)

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No use esta API en un entorno de producción.

En lugar de crear índices de caché manualmente, considere usar enablePersistentCacheIndexAutoCreation() para permitir que el SDK decida si crear índices de caché para consultas que se ejecutan localmente.

Configura la indexación para la ejecución de consultas locales. Cualquier configuración de índice anterior se anula. La Promise se resuelve una vez que se ha persistido la configuración del índice.

Las entradas de índice en sí se crean asincrónicamente. Puede continuar utilizando consultas que requieren indexación incluso si los índices aún no están disponibles. La ejecución de la consulta comenzará automáticamente a usar el índice una vez que se hayan escrito las entradas de índice.

Los índices solo son compatibles con la persistencia indexedDB. Invoke en enableIndexedDbPersistence() o enableMultiTabIndexedDbPersistence() antes de configurar una configuración de índice. Si IndexedDB no está habilitado, se ignora cualquier configuración de índice.

El método acepta el formato JSON exportado por Firebase CLI ( firebase firestore:indexes ). Si el formato JSON no es válido, este método arroja un error.

Firma:

export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego La instancia de Firestore para configurar índices para.
json cadena El formato JSON exportado por Firebase CLI.

Devoluciones:

Promesa<nulo>

Una Promise que se resuelve una vez que todos los índices se configuran con éxito.

Excepciones

FirestoreError si el formato JSON no es válido.

Terminar (Firestore)

Termina la instancia de Firestore proporcionada.

Después de llamar terminate() solo se puede usar la función clearIndexedDbPersistence() . Cualquier otra función arrojará un FirestoreError .

Para reiniciar después de la terminación, cree una nueva instancia de FirebaseFirestore con GetFirestore () .

La terminación no cancela ninguna escritura pendiente, y no se resolverá cualquier promesa que esté en espera de una respuesta del servidor. Si tiene habilitado la persistencia, la próxima vez que comience esta instancia, reanudará el envío de estas escrituras al servidor.

Firma:

export declare function terminate(firestore: Firestore): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego

Devoluciones:

Promesa<nulo>

Una Promise que se resuelve cuando la instancia se ha terminado con éxito.

WaitForPendingWrites (Firestore)

Espera hasta que todas las escrituras actualmente pendientes para el usuario activo hayan sido reconocidos por el backend.

La promesa devuelta se resuelve de inmediato si no hay escrituras pendientes. De lo contrario, la promesa espera todas las escrituras emitidas anteriormente (incluidas las escritas en una sesión de aplicación anterior), pero no espera escrituras que se agregaron después de que se llame la función. Si desea esperar escrituras adicionales, llame waitForPendingWrites() nuevamente.

Cualquier promesa sobresaliente waitForPendingWrites() se rechazan durante los cambios de usuario.

Firma:

export declare function waitForPendingWrites(firestore: Firestore): Promise<void>;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego

Devoluciones:

Promesa<nulo>

Una Promise que resuelve cuándo todas las escrituras pendientes actualmente han sido reconocidas por el backend.

WriteBatch (Firestore)

Crea un lote de escritura, utilizado para realizar múltiples escrituras como una sola operación atómica. El número máximo de escrituras permitidas en una sola escritura es 500.

A diferencia de las transacciones, los lotes de escritura se persisten fuera de línea y, por lo tanto, son preferibles cuando no necesita acondicionar sus escrituras en datos de lectura.

Firma:

export declare function writeBatch(firestore: Firestore): WriteBatch;

Parámetros

Parámetro Tipo Descripción
tienda de fuego Tienda de fuego

Devoluciones:

escribir lote

Un BriteBatch que puede usarse para ejecutar atómicamente múltiples escrituras.

función()

contar()

Cree un objeto AggregateField que pueda usarse para calcular el recuento de documentos en el conjunto de resultados de una consulta.

Firma:

export declare function count(): AggregateField<number>;

Devoluciones:

Campo agregado <número>

Deletefield ()

Devuelve un Sentinel para usar con actualateC () o setDoc () con {merge: true} para marcar un campo para la eliminación.

Firma:

export declare function deleteField(): FieldValue;

Devoluciones:

Valor de campo

documentId ()

Devuelve un Sentinel FieldPath especial para referirse a la identificación de un documento. Se puede usar en consultas para ordenar o filtrar mediante la identificación del documento.

Firma:

export declare function documentId(): FieldPath;

Devoluciones:

Ruta de campo

getFirestore ()

Devuelve la instancia de Firestore predeterminada existente que está asociada con el FirebaseApp predeterminado . Si no existe ninguna instancia, inicializa una nueva instancia con la configuración predeterminada.

Firma:

export declare function getFirestore(): Firestore;

Devoluciones:

Tienda de fuego

La instancia predeterminada de Firestore de la aplicación predeterminada.

MemoryEagerGageCollector ()

Crea una instancia de MemoryEagerGarbageCollector . Este es también el recolector de basura predeterminado a menos que se especifique explícitamente lo contrario.

Firma:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Devoluciones:

MemoryEagerGageCollector

PersistentMultIlPletabManager ()

Crea una instancia de PersistentMultipleTabManager .

Firma:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Devoluciones:

PersistentMultIPletAbmanager

SerververImestamp ()

Devuelve un Sentinel utilizado con SetDoc () o UpdateDoc () para incluir una marca de tiempo generada por el servidor en los datos escritos.

Firma:

export declare function serverTimestamp(): FieldValue;

Devoluciones:

Valor de campo

función (base de datos, ...)

GetFirestore (DatabaseId)

Esta API se proporciona como una vista previa para los desarrolladores y puede cambiar según los comentarios que recibamos. No use esta API en un entorno de producción.

Devuelve la instancia existente llamada Firestore que está asociada con el FirebaseApp predeterminado . Si no existe ninguna instancia, inicializa una nueva instancia con la configuración predeterminada.

Firma:

export declare function getFirestore(databaseId: string): Firestore;

Parámetros

Parámetro Tipo Descripción
base de datos cadena El nombre de la base de datos.

Devoluciones:

Tienda de fuego

La instancia de Firestore nombrada de la aplicación predeterminada.

función (elementos, ...)

Arrayremove (elementos)

Devuelve un valor especial que se puede usar con setDoc () o que le indique al servidor que elimine los elementos dados de cualquier valor de matriz que ya existe en el servidor. Todas las instancias de cada elemento especificado se eliminarán de la matriz. Si el campo que se modifica ya no es una matriz, se sobrescribirá con una matriz vacía.

Firma:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

Parámetros

Parámetro Tipo Descripción
elementos desconocido[] Los elementos para eliminar de la matriz.

Devoluciones:

Valor de campo

El FieldValue Sentinel para su uso en una llamada a setDoc() o updateDoc()

Arrayunion (elementos)

Devuelve un valor especial que se puede usar con SetDoc () o UpdateateC () que le indique al servidor que se unan a los elementos dados con cualquier valor de matriz que ya exista en el servidor. Cada elemento especificado que ya no existe en la matriz se agregará al final. Si el campo que se modifica ya no es una matriz, se sobrescribirá con una matriz que contiene exactamente los elementos especificados.

Firma:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

Parámetros

Parámetro Tipo Descripción
elementos desconocido[] Los elementos para la unión en la matriz.

Devoluciones:

Valor de campo

El FieldValue Sentinel para su uso en una llamada a setDoc() o updateDoc() .

función (campo, ...)

promedio (campo)

Cree un objeto AggregateField que pueda usarse para calcular el promedio de un campo especificado en un rango de documentos en el conjunto de resultados de una consulta.

Firma:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

Parámetros

Parámetro Tipo Descripción
campo cadena | Ruta de campo Especifica que el campo promedia en todo el conjunto de resultados.

Devoluciones:

Campo agregado <Número | nulo>

suma (campo)

Cree un objeto AggregateField que pueda usarse para calcular la suma de un campo especificado en un rango de documentos en el conjunto de resultados de una consulta.

Firma:

export declare function sum(field: string | FieldPath): AggregateField<number>;

Parámetros

Parámetro Tipo Descripción
campo cadena | Ruta de campo Especifica el campo a sumar en el conjunto de resultados.

Devoluciones:

Campo agregado <número>

función (FieldPath, ...)

Orderby (FieldPath, DirectionsTR)

Crea una consulta de consignación que clasifica el resultado de la consulta por el campo especificado, opcionalmente en orden descendente en lugar de ascender.

Firma:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

Parámetros

Parámetro Tipo Descripción
trayectoria cadena | Ruta de campo El campo para clasificar.
direcciones OrderByDirection Dirección opcional para ordenar ('ASC' o 'Desc'). Si no se especifica, el orden ascenderá.

Devoluciones:

QueryOrderByConstraint

La consulta creada .

Dónde (FieldPath, Opstr, Value)

Crea una CONSTRAENCIÓN DE LA QUERYFIELDFILTER que aplica que los documentos deben contener el campo especificado y que el valor debe satisfacer la restricción de relación proporcionada.

Firma:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

Parámetros

Parámetro Tipo Descripción
trayectoria cadena | Ruta de campo El camino para comparar
OPSTR DondeFilterOp La cadena de operación (por ejemplo, "& lt;", "& lt; =", "==", "& lt;", "& lt; =", "! =").
valor desconocido El valor para la comparación

Devoluciones:

QueryFieldFilterConstraint

La consulta creada .

función (Values ​​de campo, ...)

Endat (Values ​​de campo)

Crea una consulta de consulta que modifica el resultado establecido para finalizar en los campos proporcionados en relación con el orden de la consulta. El orden de los valores de campo debe coincidir con el orden del orden por cláusulas de la consulta.

Firma:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

Parámetros

Parámetro Tipo Descripción
valores de campo desconocido[] Los valores de campo para finalizar esta consulta en, en orden de la orden de la consulta por.

Devoluciones:

Consulta

Una consulta de la Constalación para pasar a query()

Endbefore (Values ​​de campo)

Crea una consulta de consulta que modifica el resultado establecido para finalizar antes de los campos proporcionados en relación con el orden de la consulta. El orden de los valores de campo debe coincidir con el orden del orden por cláusulas de la consulta.

Firma:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

Parámetros

Parámetro Tipo Descripción
valores de campo desconocido[] Los valores de campo para finalizar esta consulta antes, en orden de la orden de la consulta por.

Devoluciones:

Consulta

Una consulta de la Constalación para pasar a query()

startafter (Values ​​de campo)

Crea una consulta de consulta que modifica el resultado establecido para comenzar después de los campos proporcionados en relación con el orden de la consulta. El orden de los valores de campo debe coincidir con el orden del orden por cláusulas de la consulta.

Firma:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

Parámetros

Parámetro Tipo Descripción
valores de campo desconocido[] Los valores de campo para comenzar esta consulta después, en orden de la orden de la consulta por.

Devoluciones:

Consulta

Una consulta de query()

Startat (Values ​​de campo)

Crea una consulta de consulta que modifica el resultado establecido para comenzar en los campos proporcionados en relación con el orden de la consulta. El orden de los valores de campo debe coincidir con el orden del orden por cláusulas de la consulta.

Firma:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

Parámetros

Parámetro Tipo Descripción
valores de campo desconocido[] Los valores de campo para comenzar esta consulta en, en orden de la orden de la consulta.

Devoluciones:

Consulta

Una consulta de query() .

función (indexManager, ...)

DeleteAllPersistentCacheIndexes (indexManager)

Elimina todos los índices de caché persistentes.

Tenga en cuenta que esta función también eliminará los índices generados por setIndexConfiguration() , que está en desuso.

Firma:

export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

Parámetros

Parámetro Tipo Descripción
IndexManager PersistentCacheIndexManager

Devoluciones:

vacío

DesactivePersistentCacheIndexautocreation (indexManager)

Deja de crear índices de caché persistentes automáticamente para la ejecución de consultas locales. Los índices que se han creado llamando a enablePersistentCacheIndexAutoCreation() todavía entran en vigencia.

Firma:

export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Parámetros

Parámetro Tipo Descripción
IndexManager PersistentCacheIndexManager

Devoluciones:

vacío

HabilitarPersistentCacheIndexautocreation (indexManager)

Permite al SDK crear índices de caché persistentes automáticamente para la ejecución de la consulta local cuando el SDK cree que los índices de caché pueden ayudar a mejorar el rendimiento.

Esta función esta desactivada por defecto.

Firma:

export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;

Parámetros

Parámetro Tipo Descripción
IndexManager PersistentCacheIndexManager

Devoluciones:

vacío

función (izquierda, ...)

AgregateFieldEqual (izquierda, derecha)

Compara dos 'Aggregatefield `Instancias de igualdad.

Firma:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

Parámetros

Parámetro Tipo Descripción
izquierda Campo agregado <desconocido> Compare este AggregateField con la right .
bien Campo agregado <desconocido> Compare this AggregateField to the left .

Devoluciones:

booleano

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

Two AggregateQuerySnapshot instances are considered "equal" if they have underlying queries that compare equal, and the same data.

Firma:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

Parámetros

Parámetro Tipo Descripción
izquierda Instantánea de consulta agregada <AggregateSpecType, AppModelType, DbModelType> The first AggregateQuerySnapshot to compare.
bien Instantánea de consulta agregada <AggregateSpecType, AppModelType, DbModelType> The second AggregateQuerySnapshot to compare.

Devoluciones:

booleano

true if the objects are "equal", as defined above, or false otherwise.

queryEqual(left, right)

Returns true if the provided queries point to the same collection and apply the same constraints.

Firma:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

Parámetros

Parámetro Tipo Descripción
izquierda Consulta <AppModelType, DbModelType> A Query to compare.
bien Consulta <AppModelType, DbModelType> A Query to compare.

Devoluciones:

booleano

true if the references point to the same location in the same Firestore database.

refEqual(left, right)

Returns true if the provided references are equal.

Firma:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

Parámetros

Parámetro Tipo Descripción
izquierda Referencia de documento <AppModelType, DbModelType> | ColecciónReferencia <AppModelType, DbModelType> A reference to compare.
bien Referencia de documento <AppModelType, DbModelType> | ColecciónReferencia <AppModelType, DbModelType> A reference to compare.

Devoluciones:

booleano

true if the references point to the same location in the same Firestore database.

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

Firma:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

Parámetros

Parámetro Tipo Descripción
izquierda Instantánea del documento <AppModelType, DbModelType> | ConsultaInstantánea <AppModelType, DbModelType> A snapshot to compare.
bien Instantánea del documento <AppModelType, DbModelType> | ConsultaInstantánea <AppModelType, DbModelType> A snapshot to compare.

Devoluciones:

booleano

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Firma:

export declare function limit(limit: number): QueryLimitConstraint;

Parámetros

Parámetro Tipo Descripción
límite número El número máximo de artículos a devolver.

Devoluciones:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

You must specify at least one orderBy clause for limitToLast queries, otherwise an exception will be thrown during execution.

Firma:

export declare function limitToLast(limit: number): QueryLimitConstraint;

Parámetros

Parámetro Tipo Descripción
límite número El número máximo de artículos a devolver.

Devoluciones:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

Firma:

export declare function setLogLevel(logLevel: LogLevel): void;

Parámetros

Parámetro Tipo Descripción
nivel de registro Nivel de registro The verbosity you set for activity and error logging. Can be any of the following values:
  • debug for the most verbose logging level, primarily for debugging.
  • error to log errors only.
  • silent to turn off logging.

Devoluciones:

vacío

function(n, ...)

increment(n)

Returns a special value that can be used with setDoc() or updateDoc() that tells the server to increment the field's current value by the given value.

If either the operand or the current field value uses floating point precision, all arithmetic follows IEEE 754 semantics. If both values are integers, values outside of JavaScript's safe number range ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER ) are also subject to precision loss. Furthermore, once processed by the Firestore backend, all integer operations are capped between -2^63 and 2^63-1.

If the current field value is not of type number , or if the field does not yet exist, the transformation sets the field to the given value.

Firma:

export declare function increment(n: number): FieldValue;

Parámetros

Parámetro Tipo Descripción
norte número The value to increment by.

Devoluciones:

Valor de campo

The FieldValue sentinel for use in a call to setDoc() or updateDoc()

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

Calculates the specified aggregations over the documents in the result set of the given query without actually downloading the documents.

Using this function to perform aggregations is efficient because only the final aggregation values, not the documents' data, are downloaded. This function can perform aggregations of the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Firma:

export declare function getAggregateFromServer<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType> The query whose result set is aggregated over.
aggregateSpec AggregateSpecType An AggregateSpec object that specifies the aggregates to perform over the result set. The AggregateSpec specifies aliases for each aggregate, which can be used to retrieve the aggregate result.

Devoluciones:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Ejemplo

const aggregateSnapshot = await getAggregateFromServer(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCountFromServer(query)

Calculates the number of documents in the result set of the given query without actually downloading the documents.

Using this function to count the documents is efficient because only the final count, not the documents' data, is downloaded. This function can count the documents in cases where the result set is prohibitively large to download entirely (thousands of documents).

The result received from the server is presented, unaltered, without considering any local state. That is, documents in the local cache are not taken into consideration, neither are local modifications not yet synchronized with the server. Previously-downloaded results, if any, are not used. Every invocation of this function necessarily involves a round trip to the server.

Firma:

export declare function getCountFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType> The query whose result set size is calculated.

Devoluciones:

Promise< AggregateQuerySnapshot <{ count: AggregateField <number>; }, AppModelType, DbModelType>>

A Promise that will be resolved with the count; the count can be retrieved from snapshot.data().count , where snapshot is the AggregateQuerySnapshot to which the returned Promise resolves.

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

Firma:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType>

Devoluciones:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromCache(query)

Executes the query and returns the results as a QuerySnapshot from cache. Returns an empty result set if no documents matching the query are currently cached.

Firma:

export declare function getDocsFromCache<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType>

Devoluciones:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

getDocsFromServer(query)

Executes the query and returns the results as a QuerySnapshot from the server. Returns an error if the network is not available.

Firma:

export declare function getDocsFromServer<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType>

Devoluciones:

Promise< QuerySnapshot <AppModelType, DbModelType>>

A Promise that will be resolved with the results of the query.

onSnapshot(query, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType> The query to listen to.
observador { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

Devoluciones:

Darse de baja

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, observer)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType> The query to listen to.
opciones InstantáneaEscucharOpciones Options controlling the listen behavior.
observador { next?: (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

Devoluciones:

Darse de baja

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType> The query to listen to.
En el siguiente (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
enError (error: FirestoreError ) => vacío A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
en la terminación () => nulo Can be provided, but will not be called since streams are never ending.

Devoluciones:

Darse de baja

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(query, options, onNext, onError, onCompletion)

Attaches a listener for QuerySnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks. The listener can be cancelled by calling the function that is returned when onSnapshot is called.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType> The query to listen to.
opciones InstantáneaEscucharOpciones Options controlling the listen behavior.
En el siguiente (snapshot: QuerySnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new QuerySnapshot is available.
enError (error: FirestoreError ) => vacío A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
en la terminación () => nulo Can be provided, but will not be called since streams are never ending.

Devoluciones:

Darse de baja

An unsubscribe function that can be called to cancel the snapshot listener.

query(query, compositeFilter, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Firma:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
compositeFilter QueryCompositeFilterConstraint The QueryCompositeFilterConstraint to apply. Create QueryCompositeFilterConstraint using and() or or() .
queryConstraints QueryNonFilterConstraint [] Additional QueryNonFilterConstraint s to apply (eg orderBy() , límite() ).

Devoluciones:

Consulta <AppModelType, DbModelType>

Excepciones

if any of the provided query constraints cannot be combined with the existing or new constraints.

query(query, queryConstraints)

Creates a new immutable instance of Query that is extended to also include additional query constraints.

Firma:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

Parámetros

Parámetro Tipo Descripción
consulta Consulta <AppModelType, DbModelType> The Query instance to use as a base for the new constraints.
queryConstraints QueryConstraint [] The list of QueryConstraint s to apply.

Devoluciones:

Consulta <AppModelType, DbModelType>

Excepciones

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(queryConstraints, ...)

and(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a conjunction of the given filter constraints. A conjunction filter includes a document if it satisfies all of the given filters.

Firma:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Parámetros

Parámetro Tipo Descripción
queryConstraints Restricción de filtro de consulta [] Opcional. The list of QueryFilterConstraint s to perform a conjunction for. These must be created with calls to where() , o() , o y() .

Devoluciones:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

Creates a new QueryCompositeFilterConstraint that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters.

Firma:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

Parámetros

Parámetro Tipo Descripción
queryConstraints Restricción de filtro de consulta [] Opcional. The list of QueryFilterConstraint s to perform a disjunction for. These must be created with calls to where() , o() , o y() .

Devoluciones:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

Add a new document to specified CollectionReference with the given data, assigning it a document ID automatically.

Firma:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
referencia ColecciónReferencia <AppModelType, DbModelType> A reference to the collection to add this document to.
datos WithFieldValue <AppModelType> An Object containing the data for the new document.

Devoluciones:

Promise< DocumentReference <AppModelType, DbModelType>>

A Promise resolved with a DocumentReference pointing to the newly created document after it has been written to the backend (Note that it won't resolve while you're offline).

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

Firma:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parámetros

Parámetro Tipo Descripción
referencia ColecciónReferencia <AppModelType, DbModelType> A reference to a collection.
camino cadena A slash-separated path to a collection.
pathSegments cadena[] Additional path segments to apply relative to the first argument.

Devoluciones:

ColecciónReferencia < DocumentData , DocumentData >

The CollectionReference instance.

Excepciones

If the final path has an even number of segments and does not point to a collection.

collection(reference, path, pathSegments)

Gets a CollectionReference instance that refers to a subcollection of reference at the the specified relative path.

Firma:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to a Firestore document.
camino cadena A slash-separated path to a collection.
pathSegments cadena[] Additional path segments that will be applied relative to the first argument.

Devoluciones:

ColecciónReferencia < DocumentData , DocumentData >

The CollectionReference instance.

Excepciones

If the final path has an even number of segments and does not point to a collection.

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

Firma:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to delete.

Devoluciones:

Promesa<nulo>

A Promise resolved once the document has been successfully deleted from the backend (note that it won't resolve while you're offline).

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference .

Firma:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

Parámetros

Parámetro Tipo Descripción
referencia ColecciónReferencia <AppModelType, DbModelType> A reference to a collection.
camino cadena A slash-separated path to a document. Has to be omitted to use auto-genrated IDs.
pathSegments cadena[] Additional path segments that will be applied relative to the first argument.

Devoluciones:

Referencia de documento <AppModelType, DbModelType>

The DocumentReference instance.

Excepciones

If the final path has an odd number of segments and does not point to a document.

doc(reference, path, pathSegments)

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

Firma:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to a Firestore document.
camino cadena A slash-separated path to a document.
pathSegments cadena[] Additional path segments that will be applied relative to the first argument.

Devoluciones:

Referencia de documento < DocumentData , DocumentData >

The DocumentReference instance.

Excepciones

If the final path has an odd number of segments and does not point to a document.

getDoc(reference)

Reads the document referred to by this DocumentReference .

Firma:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> The reference of the document to fetch.

Devoluciones:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromCache(reference)

Reads the document referred to by this DocumentReference from cache. Returns an error if the document is not currently cached.

Firma:

export declare function getDocFromCache<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType>

Devoluciones:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

getDocFromServer(reference)

Reads the document referred to by this DocumentReference from the server. Returns an error if the network is not available.

Firma:

export declare function getDocFromServer<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType>

Devoluciones:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

A Promise resolved with a DocumentSnapshot containing the current document contents.

onSnapshot(reference, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to listen to.
observador { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

Devoluciones:

Darse de baja

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, observer)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, observer: {
    next?: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void;
    error?: (error: FirestoreError) => void;
    complete?: () => void;
}): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to listen to.
opciones InstantáneaEscucharOpciones Options controlling the listen behavior.
observador { next?: (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void; error?: (error: FirestoreError ) => void; complete?: () => void; } A single object containing next and error callbacks.

Devoluciones:

Darse de baja

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to listen to.
En el siguiente (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
enError (error: FirestoreError ) => vacío A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
en la terminación () => nulo Can be provided, but will not be called since streams are never ending.

Devoluciones:

Darse de baja

An unsubscribe function that can be called to cancel the snapshot listener.

onSnapshot(reference, options, onNext, onError, onCompletion)

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Firma:

export declare function onSnapshot<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<AppModelType, DbModelType>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to listen to.
opciones InstantáneaEscucharOpciones Options controlling the listen behavior.
En el siguiente (snapshot: DocumentSnapshot <AppModelType, DbModelType>) => void A callback to be called every time a new DocumentSnapshot is available.
enError (error: FirestoreError ) => vacío A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
en la terminación () => nulo Can be provided, but will not be called since streams are never ending.

Devoluciones:

Darse de baja

An unsubscribe function that can be called to cancel the snapshot listener.

setDoc(reference, data)

Writes to the document referred to by this DocumentReference . Si el documento aún no existe, se creará.

Firma:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to write.
datos WithFieldValue <AppModelType> A map of the fields and values for the document.

Devoluciones:

Promesa<nulo>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

setDoc(reference, data, options)

Writes to the document referred to by the specified DocumentReference . Si el documento aún no existe, se creará. If you provide merge or mergeFields , the provided data can be merged into an existing document.

Firma:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to write.
datos PartialWithFieldValue <AppModelType> A map of the fields and values for the document.
opciones Establecer opciones An object to configure the set behavior.

Devoluciones:

Promesa<nulo>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, data)

Updates fields in the document referred to by the specified DocumentReference . The update will fail if applied to a document that does not exist.

Firma:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to update.
datos Actualizar datos <DbModelType> An object containing the fields and values with which to update the document. Fields can contain dots to reference nested fields within the document.

Devoluciones:

Promesa<nulo>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

updateDoc(reference, field, value, moreFieldsAndValues)

Updates fields in the document referred to by the specified DocumentReference The update will fail if applied to a document that does not exist.

Nested fields can be updated by providing dot-separated field path strings or by providing FieldPath objects.

Firma:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

Parámetros

Parámetro Tipo Descripción
referencia Referencia de documento <AppModelType, DbModelType> A reference to the document to update.
campo cadena | Ruta de campo The first field to update.
valor desconocido The first value.
moreFieldsAndValues desconocido[] Additional key value pairs.

Devoluciones:

Promesa<nulo>

A Promise resolved once the data has been successfully written to the backend (note that it won't resolve while you're offline).

function(settings, ...)

memoryLocalCache(settings)

Creates an instance of MemoryLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Firma:

export declare function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;

Parámetros

Parámetro Tipo Descripción
ajustes Configuración de memoria caché

Devoluciones:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

A target size can be specified as part of the setting parameter. The collector will start deleting documents once the cache size exceeds the given size. The default cache size is 40MB (40 * 1024 * 1024 bytes).

Firma:

export declare function memoryLruGarbageCollector(settings?: {
    cacheSizeBytes?: number;
}): MemoryLruGarbageCollector;

Parámetros

Parámetro Tipo Descripción
ajustes { cacheSizeBytes?: number; }

Devoluciones:

MemoryLruGarbageCollector

persistentLocalCache(settings)

Creates an instance of PersistentLocalCache . The instance can be set to FirestoreSettings.cache to tell the SDK which cache layer to use.

Persistent cache cannot be used in a Node.js environment.

Firma:

export declare function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

Parámetros

Parámetro Tipo Descripción
ajustes Configuración de caché persistente

Devoluciones:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Firma:

export declare function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

Parámetros

Parámetro Tipo Descripción
ajustes PersistentSingleTabManagerSettings | indefinido Configures the created tab manager.

Devoluciones:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Firma:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Parámetros

Parámetro Tipo Descripción
instantánea Instantánea del documento <AppModelType, DbModelType> The snapshot of the document to end at.

Devoluciones:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

Creates a QueryEndAtConstraint that modifies the result set to end before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Firma:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

Parámetros

Parámetro Tipo Descripción
instantánea Instantánea del documento <AppModelType, DbModelType> The snapshot of the document to end before.

Devoluciones:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start after the provided document (exclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of the query.

Firma:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Parámetros

Parámetro Tipo Descripción
instantánea Instantánea del documento <AppModelType, DbModelType> The snapshot of the document to start after.

Devoluciones:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

Creates a QueryStartAtConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

Firma:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

Parámetros

Parámetro Tipo Descripción
instantánea Instantánea del documento <AppModelType, DbModelType> The snapshot of the document to start at.

Devoluciones:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

Constant used to indicate the LRU garbage collection should be disabled. Set this value as the cacheSizeBytes on the settings passed to the Firestore instance.

Firma:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

Returns a new map where every key is prefixed with the outer key appended to a dot.

Firma:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

Tipo de campo agregado

La unión de todos los tipos AggregateField admitidos por Firestore.

Firma:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

Datos de especificación agregados

A type whose keys are taken from an AggregateSpec , and whose values are the result of the aggregation performed by the corresponding AggregateField from the input AggregateSpec .

Firma:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

AggregateType

Union type representing the aggregate type to be performed.

Firma:

export declare type AggregateType = 'count' | 'avg' | 'sum';

ChildUpdateFields

Helper for calculating the nested fields for a given type T1. This is needed to distribute union types such as undefined | {...} (happens for optional props) or {a: A} | {b: B} .

In this use case, V is used to distribute the union types of T[K] on Record , since T[K] is evaluated as an expression and not distributed.

See https://www.typescriptlang.org/docs/handbook/advanced-types.html#distributive-conditional-types

Firma:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

Tipo de cambio de documento

El tipo de DocumentChange puede ser "agregado", "eliminado" o "modificado".

Firma:

export declare type DocumentChangeType = 'added' | 'removed' | 'modified';

FirestoreErrorCode

The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md

Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (eg an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. Para operaciones que cambian el estado del sistema, este error puede aparecer incluso si la operación se completó exitosamente. Por ejemplo, una respuesta exitosa de un servidor podría haberse retrasado lo suficiente como para que expirara el plazo. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Significa que se han roto algunas invariantes esperadas por el sistema subyacente. Si ve uno de estos errores, algo está muy roto. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation.

Firma:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

FirestoreLocalCache

Union type from all supported SDK cache layer.

Firma:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

Set to default to listen to both cache and server changes. Set to cache to listen to changes in cache only.

Firma:

export declare type ListenSource = 'default' | 'cache';

MemoryGarbageCollector

Union type from all support gabage collectors for memory local cache.

Firma:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

For each field (eg 'bar'), find all nested keys (eg { 'bar.baz': T1, 'bar.qux': T2 } ). Intersect them together to make a single map containing all possible keys that are all marked as optional

Firma:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

OrderByDirection

The direction of a orderBy() clause is specified as 'desc' or 'asc' (descending or ascending).

Firma:

export declare type OrderByDirection = 'desc' | 'asc';

PartialWithFieldValue

Similar to Typescript's Partial<T> , but allows nested fields to be omitted and FieldValues to be passed in as property values.

Firma:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

PersistentTabManager

A union of all available tab managers.

Firma:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Primitivo

Primitive types.

Firma:

export declare type Primitive = string | number | boolean | undefined | null;

QueryConstraintType

Describes the different query constraints available in this SDK.

Firma:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

Restricción de filtro de consulta

QueryFilterConstraint is a helper union type that represents QueryFieldFilterConstraint and QueryCompositeFilterConstraint .

Firma:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint is a helper union type that represents QueryConstraints which are used to narrow or order the set of documents, but that do not explicitly filter on a document field. QueryNonFilterConstraint s are created by invoking orderBy() , Empieza en() , startAfter() , endBefore() , termina en() , limit() or limitToLast() and can then be passed to query() to create a new query instance that also contains the QueryConstraint .

Firma:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

Establecer opciones

An options object that configures the behavior of setDoc() , and calls. These calls can be configured to perform granular merges instead of overwriting the target documents in their entirety by providing a SetOptions with merge: true .

Firma:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

Estado de tarea

Representa el estado de las tareas de carga de paquetes.

Both 'Error' and 'Success' are sinking state: task will abort or complete and there will be no more updates after they are reported.

Firma:

export declare type TaskState = 'Error' | 'Running' | 'Success';

unión a la intersección

Given a union type U = T1 | T2 | ... , returns an intersected type (T1 & T2 & ...) .

Uses distributive conditional types and inference from conditional types. This works because multiple candidates for the same type variable in contra-variant positions causes an intersection type to be inferred. https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-to-intersection -tipo

Firma:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

Actualizar datos

Update data (for use with updateDoc() ) that consists of field paths (eg 'foo' or 'foo.baz') mapped to values. Fields that contain dots reference nested fields within the document. FieldValues can be passed in as property values.

Firma:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

DondeFilterOp

Filter conditions in a where() clause are specified using the strings '&lt;', '&lt;=', '==', '!=', '&gt;=', '&gt;', 'array-contains', 'in', 'array-contains-any', and 'not-in'.

Firma:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

WithFieldValue

Allows FieldValues to be passed in as a property value while maintaining type safety.

Firma:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);