database package

Base de datos en tiempo real de Firebase

Funciones

Función Descripción
función (aplicación, ...)
obtenerBase de datos (aplicación, URL) Devuelve la instancia del SDK de Realtime Database asociado con la FirebaseApp proporcionada. . Inicializa una nueva instancia con la configuración predeterminada si no existe ninguna instancia o si la instancia existente utiliza una URL de base de datos personalizada.
función(db,...)
connectDatabaseEmulator(db, host, puerto, opciones) Modifique la instancia proporcionada para comunicarse con el emulador de Realtime Database.

Nota: Este método debe llamarse antes de realizar cualquier otra operación.

ir sin conexión (db) Se desconecta del servidor (todas las operaciones de la base de datos se completarán sin conexión). El cliente mantiene automáticamente una conexión persistente con el servidor de la base de datos, que permanecerá activa indefinidamente y se volverá a conectar cuando se desconecte. Sin embargo, los métodos goOffline() y goOnline() se pueden utilizar para controlar la conexión del cliente en los casos en que una conexión persistente no sea deseable. Mientras esté desconectado, el cliente ya no recibirá actualizaciones de datos de la base de datos. Sin embargo, todas las operaciones de la base de datos realizadas localmente continuarán activando eventos de inmediato, lo que permitirá que su aplicación continúe comportándose normalmente. Además, cada operación realizada localmente se pondrá en cola y se volverá a intentar automáticamente al volver a conectarse al servidor de la base de datos. Para volver a conectarse a la base de datos y comenzar a recibir eventos remotos, consulte goOnline() .
ir en línea (db) Se vuelve a conectar al servidor y sincroniza el estado de la base de datos fuera de línea con el estado del servidor. Este método debe usarse después de deshabilitar la conexión activa con goOffline() . Una vez reconectado, el cliente transmitirá los datos adecuados y activará los eventos apropiados para que su cliente se "ponga al día" automáticamente.
ref(base de datos, ruta) Devuelve una Reference que representa la ubicación en la base de datos correspondiente a la ruta proporcionada. Si no se proporciona ninguna ruta, la Reference apuntará a la raíz de la base de datos.
referenciaDeURL(db,url) Devuelve una Reference que representa la ubicación en la base de datos correspondiente a la URL de Firebase proporcionada. Se produce una excepción si la URL no es una URL válida de la base de datos de Firebase o si tiene un dominio diferente al de la instancia Database actual. Tenga en cuenta que todos los parámetros de consulta ( orderBy , limitToLast , etc.) se ignoran y no se aplican a la Reference devuelta.
función()
fuerzaLongPolling() Fuerce el uso de longPolling en lugar de websockets. Esto se ignorará si se utiliza el protocolo websocket en la URL de la base de datos.
fuerzaWebSockets() Fuerce el uso de websockets en lugar de longPolling.
ordenPorClave() Crea una nueva QueryConstraint que ordena por clave. Ordena los resultados de una consulta por sus valores clave (ascendentes). Puedes leer más sobre orderByKey() en Ordenar datos .
ordenPorPrioridad() Crea una nueva QueryConstraint que ordena por prioridad. Las aplicaciones no necesitan usar prioridad, pero pueden ordenar colecciones por propiedades ordinarias (consulte Ordenar datos para alternativas a la prioridad).
ordenPorValor() Crea una nueva QueryConstraint que ordena por valor. Si los elementos secundarios de una consulta son todos valores escalares (cadena, número o booleano), puede ordenar los resultados por sus valores (ascendentes). Puedes leer más sobre orderByValue() en Ordenar datos .
marca de tiempo del servidor() Devuelve un valor de marcador de posición para completar automáticamente la marca de tiempo actual (tiempo desde la época de Unix, en milisegundos) según lo determinado por los servidores de Firebase.
función(delta,...)
incremento(delta) Devuelve un valor de marcador de posición que se puede utilizar para incrementar atómicamente el valor de la base de datos actual según el delta proporcionado.
función (habilitada, ...)
enableLogging(habilitado, persistente) Registra información de depuración en la consola.
función(límite, ...)
límiteAPrimero(límite) Crea una nueva QueryConstraint que se limita al primer número específico de hijos. El método limitToFirst() se utiliza para establecer un número máximo de elementos secundarios que se sincronizarán para una devolución de llamada determinada. Si establecemos un límite de 100, inicialmente solo recibiremos hasta 100 eventos child_added . Si tenemos menos de 100 mensajes almacenados en nuestra base de datos, se activará un evento child_added para cada mensaje. Sin embargo, si tenemos más de 100 mensajes, solo recibiremos un evento child_added para los primeros 100 mensajes ordenados. A medida que los elementos cambien, recibiremos eventos child_removed por cada elemento que salga de la lista activa para que el número total permanezca en 100. Puedes leer más sobre limitToFirst() en Filtrado de datos. .
límite al último (límite) Crea una nueva QueryConstraint que está limitada a devolver solo el último número de hijos especificado. El método limitToLast() se utiliza para establecer un número máximo de elementos secundarios que se sincronizarán para una devolución de llamada determinada. Si establecemos un límite de 100, inicialmente solo recibiremos hasta 100 eventos child_added . Si tenemos menos de 100 mensajes almacenados en nuestra base de datos, se activará un evento child_added para cada mensaje. Sin embargo, si tenemos más de 100 mensajes, solo recibiremos un evento child_added para los últimos 100 mensajes ordenados. A medida que los elementos cambien, recibiremos eventos child_removed por cada elemento que salga de la lista activa para que el número total permanezca en 100. Puedes leer más sobre limitToLast() en Filtrado de datos. .
función(registrador, ...)
enableLogging(registrador) Registra información de depuración en la consola.
función (padre, ...)
hijo (padre, ruta) Obtiene una Reference para la ubicación en la ruta relativa especificada. La ruta relativa puede ser un nombre secundario simple (por ejemplo, "ada") o una ruta más profunda separada por barras (por ejemplo, "ada/nombre/primero").
empujar (padre, valor) Genera una nueva ubicación secundaria usando una clave única y devuelve su Reference . Este es el patrón más común para agregar datos a una colección de elementos. Si proporciona un valor a push() , el valor se escribe en la ubicación generada. Si no pasa un valor, no se escribe nada en la base de datos y el elemento secundario permanece vacío (pero puede usar la Reference en otro lugar). Las claves únicas generadas por push() están ordenadas por hora actual, por lo que la lista resultante de elementos está ordenada cronológicamente. Las claves también están diseñadas para que sean imposibles de adivinar (contienen 72 bits aleatorios de entropía). Ver Agregar a una lista de datos . Consulte las 2^120 formas de garantizar identificadores únicos .
función (ruta, ...)
ordenPorNiño(ruta) Crea una nueva QueryConstraint que ordena según la clave secundaria especificada. Las consultas sólo pueden ordenarse por una clave a la vez. Llamar a orderByChild() varias veces en la misma consulta es un error. Las consultas de Firebase le permiten ordenar sus datos por cualquier clave secundaria sobre la marcha. Sin embargo, si sabe de antemano cuáles serán sus índices, puede definirlos mediante la regla .indexOn en sus Reglas de seguridad para un mejor rendimiento. Consulte la regla https://firebase.google.com/docs/database/security/indexing-data para obtener más información. Puedes leer más sobre orderByChild() en Ordenar datos .
función (consulta, ...)
obtener (consulta) Obtiene el resultado más actualizado para esta consulta.
off(consulta, tipo de evento, devolución de llamada) Separa una devolución de llamada previamente adjunta con el oyente on () ( onValue , onChildAdded ) correspondiente. Nota: Esta no es la forma recomendada de eliminar un oyente. En su lugar, utilice la función de devolución de llamada devuelta de las respectivas devoluciones on llamada. Separe una devolución de llamada previamente adjunta con on*() . Llamar a off() en un oyente principal no eliminará automáticamente los oyentes registrados en los nodos secundarios; también se debe llamar off() en cualquier oyente secundario para eliminar la devolución de llamada. Si no se especifica una devolución de llamada, se eliminarán todas las devoluciones de llamada para el tipo de evento especificado. De manera similar, si no se especifica ningún tipo de evento, se eliminarán todas las devoluciones de llamada de la Reference . Los oyentes individuales también pueden ser eliminados invocando sus devoluciones de llamada para cancelar la suscripción.
onChildAdded (consulta, devolución de llamada, cancelar devolución de llamada) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildAdded una vez por cada niño inicial en esta ubicación, y se activará nuevamente cada vez que se agregue un niño nuevo. El DataSnapshot pasado a la devolución de llamada reflejará los datos del niño relevante. Para fines de orden, se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildAdded(consulta, devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildAdded una vez por cada niño inicial en esta ubicación, y se activará nuevamente cada vez que se agregue un niño nuevo. El DataSnapshot pasado a la devolución de llamada reflejará los datos del niño relevante. Para fines de orden, se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildAdded (consulta, devolución de llamada, cancelar devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildAdded una vez por cada niño inicial en esta ubicación, y se activará nuevamente cada vez que se agregue un niño nuevo. El DataSnapshot pasado a la devolución de llamada reflejará los datos del niño relevante. Para fines de orden, se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildChanged (consulta, devolución de llamada, cancelar devolución de llamada) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildChanged cuando cambien los datos almacenados en un niño (o cualquiera de sus descendientes). Tenga en cuenta que un único evento child_changed puede representar múltiples cambios para el niño. El DataSnapshot pasado a la devolución de llamada contendrá el nuevo contenido secundario. Para fines de orden, a la devolución de llamada también se le pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildChanged (consulta, devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildChanged cuando cambien los datos almacenados en un niño (o cualquiera de sus descendientes). Tenga en cuenta que un único evento child_changed puede representar múltiples cambios para el niño. El DataSnapshot pasado a la devolución de llamada contendrá el nuevo contenido secundario. Para fines de orden, a la devolución de llamada también se le pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildChanged (consulta, devolución de llamada, cancelar devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildChanged cuando cambien los datos almacenados en un niño (o cualquiera de sus descendientes). Tenga en cuenta que un único evento child_changed puede representar múltiples cambios para el niño. El DataSnapshot pasado a la devolución de llamada contendrá el nuevo contenido secundario. Para fines de orden, a la devolución de llamada también se le pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildMoved (consulta, devolución de llamada, cancelar devolución de llamada) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildMoved cuando el orden de clasificación de un niño cambie de modo que cambie su posición relativa a sus hermanos. El DataSnapshot pasado a la devolución de llamada será para los datos del niño que se ha movido. También se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildMoved(consulta, devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildMoved cuando el orden de clasificación de un niño cambie de modo que cambie su posición relativa a sus hermanos. El DataSnapshot pasado a la devolución de llamada será para los datos del niño que se ha movido. También se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildMoved (consulta, devolución de llamada, cancelar devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildMoved cuando el orden de clasificación de un niño cambie de modo que cambie su posición relativa a sus hermanos. El DataSnapshot pasado a la devolución de llamada será para los datos del niño que se ha movido. También se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.
onChildRemoved (consulta, devolución de llamada, cancelar devolución de llamada) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildRemoved cada vez que se elimine un niño. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del niño que se eliminó. Un niño será retirado cuando: - un cliente llama explícitamente remove() en ese niño o en uno de sus antepasados ​​- un cliente llama a set(null) en ese niño o en uno de sus antepasados ​​- a ese niño se le eliminan todos sus hijos - hay una consulta en vigor que ahora filtra al niño (porque se cambió el orden de clasificación o se alcanzó el límite máximo)
onChildRemoved(consulta, devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildRemoved cada vez que se elimine un niño. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del niño que se eliminó. Un niño será retirado cuando: - un cliente llama explícitamente remove() en ese niño o en uno de sus antepasados ​​- un cliente llama a set(null) en ese niño o en uno de sus antepasados ​​- a ese niño se le eliminan todos sus hijos - hay una consulta en vigor que ahora filtra al niño (porque se cambió el orden de clasificación o se alcanzó el límite máximo)
onChildRemoved (consulta, devolución de llamada, cancelar devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Se activará un evento onChildRemoved cada vez que se elimine un niño. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del niño que se eliminó. Un niño será retirado cuando: - un cliente llama explícitamente remove() en ese niño o en uno de sus antepasados ​​- un cliente llama a set(null) en ese niño o en uno de sus antepasados ​​- a ese niño se le eliminan todos sus hijos - hay una consulta en vigor que ahora filtra al niño (porque se cambió el orden de clasificación o se alcanzó el límite máximo)
onValue (consulta, devolución de llamada, cancelar devolución de llamada) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Un evento onValue se activará una vez con los datos iniciales almacenados en esta ubicación y luego se activará nuevamente cada vez que los datos cambien. El DataSnapshot pasado a la devolución de llamada será para la ubicación en la que se llamó on() . No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con una DataSnapshot vacía ( val() devolverá null ).
onValue (consulta, devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Un evento onValue se activará una vez con los datos iniciales almacenados en esta ubicación y luego se activará nuevamente cada vez que los datos cambien. El DataSnapshot pasado a la devolución de llamada será para la ubicación en la que se llamó on() . No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con una DataSnapshot vacía ( val() devolverá null ).
onValue (consulta, devolución de llamada, cancelar devolución de llamada, opciones) Escucha cambios de datos en una ubicación particular. Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles. Un evento onValue se activará una vez con los datos iniciales almacenados en esta ubicación y luego se activará nuevamente cada vez que los datos cambien. El DataSnapshot pasado a la devolución de llamada será para la ubicación en la que se llamó on() . No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con una DataSnapshot vacía ( val() devolverá null ).
consulta (consulta, consultaRestricciones) Crea una nueva instancia inmutable de Query que se extiende para incluir también restricciones de consulta adicionales.
función(referencia, ...)
al desconectar (ref) Devuelve un objeto OnDisconnect ; consulte Habilitación de capacidades sin conexión en JavaScript para obtener más información sobre cómo usarlo.
eliminar (referencia) Elimina los datos en esta ubicación de la base de datos. También se eliminarán todos los datos en las ubicaciones de los niños. El efecto de la eliminación será visible inmediatamente y se activará el 'valor' del evento correspondiente. También se iniciará la sincronización de la eliminación con los servidores de Firebase y la Promesa devuelta se resolverá cuando se complete. Si se proporciona, la devolución de llamada onComplete se llamará de forma asincrónica una vez finalizada la sincronización.
ejecutarTransacción(ref, actualización de transacción, opciones) Modifica atómicamente los datos en esta ubicación. Modifique atómicamente los datos en esta ubicación. A diferencia de un set() normal, que simplemente sobrescribe los datos independientemente de su valor anterior, runTransaction() se usa para modificar el valor existente a un valor nuevo, asegurando que no haya conflictos con otros clientes que escriben en la misma ubicación al mismo tiempo. . Para lograr esto, pasa runTransaction() una función de actualización que se utiliza para transformar el valor actual en un nuevo valor. Si otro cliente escribe en la ubicación antes de que su nuevo valor se escriba correctamente, se llamará nuevamente a su función de actualización con el nuevo valor actual y se volverá a intentar la escritura. Esto sucederá repetidamente hasta que su escritura se realice correctamente sin conflictos o cancele la transacción al no devolver un valor de su función de actualización. Nota: La modificación de datos con set() cancelará cualquier transacción pendiente en esa ubicación, por lo que se debe tener mucho cuidado al mezclar set() y runTransaction() para actualizar los mismos datos. Nota: Cuando utilice transacciones con reglas de seguridad y Firebase implementadas, tenga en cuenta que un cliente necesita acceso .read además de acceso .write para poder realizar una transacción. Esto se debe a que la naturaleza de las transacciones del lado del cliente requiere que el cliente lea los datos para poder actualizarlos transaccionalmente.
establecer (ref, valor) Escribe datos en esta ubicación de base de datos. Esto sobrescribirá cualquier dato en esta ubicación y en todas las ubicaciones secundarias. El efecto de la escritura será visible inmediatamente y se activarán los eventos correspondientes ("valor", "child_added", etc.). También se iniciará la sincronización de los datos con los servidores de Firebase y la Promesa devuelta se resolverá cuando se complete. Si se proporciona, la devolución de llamada onComplete se llamará de forma asincrónica una vez finalizada la sincronización. Pasar null para el nuevo valor equivale a llamar remove() ; es decir, se eliminarán todos los datos de esta ubicación y todas las ubicaciones secundarias. set() eliminará cualquier prioridad almacenada en esta ubicación, por lo que si se desea conservar la prioridad, debe usar setWithPriority() en su lugar. Tenga en cuenta que modificar datos con set() cancelará cualquier transacción pendiente en esa ubicación, por lo que se debe tener mucho cuidado al mezclar set() y transaction() para modificar los mismos datos. Un solo set() generará un único evento de "valor" en la ubicación donde se realizó el set() .
establecerPrioridad(ref, prioridad) Establece una prioridad para los datos en esta ubicación de la base de datos. Las aplicaciones no necesitan usar prioridad, pero pueden ordenar colecciones según propiedades ordinarias (consulte Ordenar y filtrar datos ).
setWithPriority(ref, valor, prioridad) Escribe datos en la ubicación de la base de datos. Como set() pero también especifica la prioridad de esos datos. Las aplicaciones no necesitan usar prioridad, pero pueden ordenar colecciones según propiedades ordinarias (consulte Ordenar y filtrar datos ).
actualizar (ref, valores) Escribe varios valores en la base de datos a la vez. El argumento values contiene varios pares de propiedad-valor que se escribirán juntos en la base de datos. Cada propiedad secundaria puede ser una propiedad simple (por ejemplo, "nombre") o una ruta relativa (por ejemplo, "nombre/primero") desde la ubicación actual hasta los datos que se van a actualizar. A diferencia del método set() , update() se puede utilizar para actualizar selectivamente solo las propiedades a las que se hace referencia en la ubicación actual (en lugar de reemplazar todas las propiedades secundarias en la ubicación actual). El efecto de la escritura será visible inmediatamente y se activarán los eventos correspondientes ('valor', 'child_added', etc.). También se iniciará la sincronización de los datos con los servidores de Firebase y la Promesa devuelta se resolverá cuando se complete. Si se proporciona, la devolución de llamada onComplete se llamará de forma asincrónica una vez finalizada la sincronización. Una sola update() generará un único evento de "valor" en la ubicación donde se realizó la update() , independientemente de cuántos elementos secundarios se modificaron. Tenga en cuenta que modificar datos con update() cancelará cualquier transacción pendiente en esa ubicación, por lo que se debe tener mucho cuidado al mezclar update() y transaction() para modificar los mismos datos. Pasar null a update() eliminará los datos en esta ubicación. Ver Presentación de actualizaciones para múltiples ubicaciones y más .
función(valor,...)
endAt(valor, clave) Crea una QueryConstraint con el punto final especificado. El uso startAt() , startAfter() , endBefore() , endAt() y equalTo() le permite elegir puntos de inicio y finalización arbitrarios para sus consultas. El punto final es inclusivo, por lo que los niños con exactamente el valor especificado se incluirán en la consulta. El argumento clave opcional se puede utilizar para limitar aún más el rango de la consulta. Si se especifica, los hijos que tienen exactamente el valor especificado también deben tener un nombre de clave menor o igual a la clave especificada. Puedes leer más sobre endAt() en Filtrado de datos. .
endBefore(valor, clave) Crea una QueryConstraint con el punto final especificado (exclusivo). El uso startAt() , startAfter() , endBefore() , endAt() y equalTo() le permite elegir puntos de inicio y finalización arbitrarios para sus consultas. El punto final es exclusivo. Si solo se proporciona un valor, los niños con un valor menor que el valor especificado se incluirán en la consulta. Si se especifica una clave, los hijos deben tener un valor menor o igual al valor especificado y un nombre de clave menor que la clave especificada.
igual a (valor, clave) Crea una QueryConstraint que incluye elementos secundarios que coinciden con el valor especificado. El uso startAt() , startAfter() , endBefore() , endAt() y equalTo() le permite elegir puntos de inicio y finalización arbitrarios para sus consultas. El argumento clave opcional se puede utilizar para limitar aún más el rango de la consulta. Si se especifica, los hijos que tienen exactamente el valor especificado también deben tener exactamente la clave especificada como nombre de clave. Esto se puede utilizar para filtrar conjuntos de resultados con muchas coincidencias para el mismo valor. Puedes leer más sobre equalTo() en Filtrado de datos. .
startAfter(valor, clave) Crea una QueryConstraint con el punto de partida especificado (exclusivo). El uso startAt() , startAfter() , endBefore() , endAt() y equalTo() le permite elegir puntos de inicio y finalización arbitrarios para sus consultas. El punto de partida es exclusivo. Si solo se proporciona un valor, los niños con un valor mayor que el valor especificado se incluirán en la consulta. Si se especifica una clave, los hijos deben tener un valor mayor o igual que el valor especificado y un nombre de clave mayor que la clave especificada.
inicioEn(valor, clave) Crea una QueryConstraint con el punto de partida especificado. El uso startAt() , startAfter() , endBefore() , endAt() y equalTo() le permite elegir puntos de inicio y finalización arbitrarios para sus consultas. El punto de partida es inclusivo, por lo que los niños con exactamente el valor especificado se incluirán en la consulta. El argumento clave opcional se puede utilizar para limitar aún más el rango de la consulta. Si se especifica, los hijos que tienen exactamente el valor especificado también deben tener un nombre de clave mayor o igual a la clave especificada. Puedes leer más sobre startAt() en Filtrado de datos. .

Clases

Clase Descripción
Base de datos Clase que representa una base de datos en tiempo real de Firebase.
Instantánea de datos Una DataSnapshot contiene datos de una ubicación de base de datos. Cada vez que lee datos de la base de datos, los recibe como una DataSnapshot . Se pasa una DataSnapshot a las devoluciones de llamada de eventos que adjunta con on() o once() . Puede extraer el contenido de la instantánea como un objeto JavaScript llamando al método val() . Alternativamente, puede acceder a la instantánea llamando child() para devolver instantáneas secundarias (a las que luego podría llamar val() ). Una DataSnapshot es una copia inmutable y generada de manera eficiente de los datos en una ubicación de base de datos. No se puede modificar y nunca cambiará (para modificar datos, siempre se llama directamente al método set() en una Reference ).
Al desconectar La clase onDisconnect le permite escribir o borrar datos cuando su cliente se desconecta del servidor de la base de datos. Estas actualizaciones ocurren independientemente de que su cliente se desconecte limpiamente o no, por lo que puede confiar en ellas para limpiar los datos incluso si se interrumpe una conexión o un cliente falla. La clase onDisconnect se usa más comúnmente para administrar la presencia en aplicaciones donde es útil detectar cuántos clientes están conectados y cuándo otros clientes se desconectan. Consulte Habilitación de capacidades sin conexión en JavaScript para obtener más información. Para evitar problemas cuando se interrumpe una conexión antes de que las solicitudes puedan transferirse al servidor de la base de datos, se deben llamar estas funciones antes de escribir cualquier dato. Tenga en cuenta que las operaciones onDisconnect solo se activan una vez. Si desea que se realice una operación cada vez que se produce una desconexión, deberá restablecer las operaciones onDisconnect cada vez que se vuelva a conectar.
Restricción de consulta Una QueryConstraint se utiliza para limitar el conjunto de documentos devueltos por una consulta de base de datos. Los QueryConstraint se crean invocando endAt() , finalizar antes() , Empieza en() , empezar después() , límiteAPrimero() , límite al último() , ordenPorNiño() , ordenPorNiño() , orderByKey() , orderByPriority() , orderByValue() o equalTo() y luego se puede pasar a query() para crear una nueva instancia de consulta que también contenga esta QueryConstraint .
Resultado de la transacción Un tipo para el valor de resolución de runTransaction() .

Interfaces

Interfaz Descripción
Referencia de base de datos Una DatabaseReference representa una ubicación específica en su base de datos y puede usarse para leer o escribir datos en esa ubicación de la base de datos. Puede hacer referencia a la ubicación raíz o secundaria en su base de datos llamando a ref() o ref("child/path") . La escritura se realiza con el método set() y la lectura se puede realizar con el método on*() . Consulte https://firebase.google.com/docs/database/web/read-and-write
Instantánea de datos iterados Representa una instantánea secundaria de una Reference sobre la que se está iterando. La clave nunca será indefinida.
Opciones de escucha Objetos de opciones que se pueden utilizar para personalizar un oyente.
Consulta Una Query ordena y filtra los datos en una ubicación de base de datos para que solo se incluya un subconjunto de los datos secundarios. Esto se puede utilizar para ordenar una colección de datos por algún atributo (por ejemplo, la altura de los dinosaurios), así como para restringir una lista grande de elementos (por ejemplo, mensajes de chat) a un número adecuado para sincronizar con el cliente. Las consultas se crean encadenando uno o más de los métodos de filtro definidos aquí. Al igual que con DatabaseReference , puede recibir datos de una Query utilizando los métodos on*() . Solo recibirá eventos y DataSnapshot para el subconjunto de datos que coincidan con su consulta. Consulte https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data para obtener más información.
Referencia entoncesable Una Promise que también puede actuar como una DatabaseReference cuando la devuelve push() . La referencia está disponible de inmediato y la Promise se resuelve cuando se completa la escritura en el backend.
Opciones de transacción Un objeto de opciones para configurar transacciones.

Tipo de alias

Tipo Alias Descripción
Tipo de evento Una de las siguientes cadenas: "valor", "child_added", "child_changed", "child_removed" o "child_moved".
Tipo de restricción de consulta Describe las diferentes restricciones de consulta disponibles en este SDK.
Darse de baja Una devolución de llamada que se puede invocar para eliminar a un oyente.

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

obtenerBase de datos (aplicación, URL)

Devuelve la instancia del SDK de Realtime Database asociado con la FirebaseApp proporcionada. . Inicializa una nueva instancia con la configuración predeterminada si no existe ninguna instancia o si la instancia existente utiliza una URL de base de datos personalizada.

Firma:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

Parámetros

Parámetro Tipo Descripción
aplicación Aplicación Firebase La instancia de FirebaseApp a la que está asociada la instancia de Realtime Database devuelta.
URL cadena La URL de la instancia de Realtime Database a la que conectarse. Si no se proporciona, el SDK se conecta a la instancia predeterminada de la aplicación Firebase.

Devoluciones:

Base de datos

La instancia Database de la aplicación proporcionada.

función(db,...)

connectDatabaseEmulator(db, host, puerto, opciones)

Modifique la instancia proporcionada para comunicarse con el emulador de Realtime Database.

Nota: Este método debe llamarse antes de realizar cualquier otra operación.

Firma:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

Parámetros

Parámetro Tipo Descripción
base de datos Base de datos La instancia a modificar.
anfitrión cadena El host del emulador (por ejemplo: localhost)
puerto número El puerto del emulador (ej: 8080)
opciones {mockUserToken?: EmulatorMockTokenOptions | cadena; }

Devoluciones:

vacío

ir sin conexión (db)

Se desconecta del servidor (todas las operaciones de la base de datos se completarán sin conexión).

El cliente mantiene automáticamente una conexión persistente con el servidor de la base de datos, que permanecerá activa indefinidamente y se volverá a conectar cuando se desconecte. Sin embargo, los métodos goOffline() y goOnline() se pueden utilizar para controlar la conexión del cliente en los casos en que una conexión persistente no sea deseable.

Mientras esté desconectado, el cliente ya no recibirá actualizaciones de datos de la base de datos. Sin embargo, todas las operaciones de la base de datos realizadas localmente continuarán activando eventos de inmediato, lo que permitirá que su aplicación continúe comportándose normalmente. Además, cada operación realizada localmente se pondrá en cola y se volverá a intentar automáticamente al volver a conectarse al servidor de la base de datos.

Para volver a conectarse a la base de datos y comenzar a recibir eventos remotos, consulte goOnline() .

Firma:

export declare function goOffline(db: Database): void;

Parámetros

Parámetro Tipo Descripción
base de datos Base de datos La instancia para desconectarse.

Devoluciones:

vacío

ir en línea (db)

Se vuelve a conectar al servidor y sincroniza el estado de la base de datos fuera de línea con el estado del servidor.

Este método debe usarse después de deshabilitar la conexión activa con goOffline() . Una vez reconectado, el cliente transmitirá los datos adecuados y activará los eventos apropiados para que su cliente se "ponga al día" automáticamente.

Firma:

export declare function goOnline(db: Database): void;

Parámetros

Parámetro Tipo Descripción
base de datos Base de datos La instancia para volver a conectarse.

Devoluciones:

vacío

ref(base de datos, ruta)

Devuelve una Reference que representa la ubicación en la base de datos correspondiente a la ruta proporcionada. Si no se proporciona ninguna ruta, la Reference apuntará a la raíz de la base de datos.

Firma:

export declare function ref(db: Database, path?: string): DatabaseReference;

Parámetros

Parámetro Tipo Descripción
base de datos Base de datos La instancia de base de datos para la que se va a obtener una referencia.
camino cadena Ruta opcional que representa la ubicación a la que apuntará la Reference devuelta. Si no se proporciona, la Reference devuelta apuntará a la raíz de la base de datos.

Devoluciones:

Referencia de base de datos

Si se proporciona una ruta, una Reference que apunta a la ruta proporcionada. De lo contrario, una Reference que apunta a la raíz de la Base de Datos.

referenciaDeURL(db,url)

Devuelve una Reference que representa la ubicación en la base de datos correspondiente a la URL de Firebase proporcionada.

Se produce una excepción si la URL no es una URL válida de la base de datos de Firebase o si tiene un dominio diferente al de la instancia Database actual.

Tenga en cuenta que todos los parámetros de consulta ( orderBy , limitToLast , etc.) se ignoran y no se aplican a la Reference devuelta. .

Firma:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

Parámetros

Parámetro Tipo Descripción
base de datos Base de datos La instancia de base de datos para la que se va a obtener una referencia.
URL cadena La URL de Firebase a la que apuntará la Reference devuelta.

Devoluciones:

Referencia de base de datos

Una Reference que apunta a la URL de Firebase proporcionada.

función()

fuerzaLongPolling()

Fuerce el uso de longPolling en lugar de websockets. Esto se ignorará si se utiliza el protocolo websocket en la URL de la base de datos.

Firma:

export declare function forceLongPolling(): void;

Devoluciones:

vacío

fuerzaWebSockets()

Fuerce el uso de websockets en lugar de longPolling.

Firma:

export declare function forceWebSockets(): void;

Devoluciones:

vacío

ordenPorClave()

Crea una nueva QueryConstraint que ordena por clave.

Ordena los resultados de una consulta por sus valores clave (ascendentes).

Puedes leer más sobre orderByKey() en Ordenar datos .

Firma:

export declare function orderByKey(): QueryConstraint;

Devoluciones:

Restricción de consulta

ordenPorPrioridad()

Crea una nueva QueryConstraint que ordena por prioridad.

Las aplicaciones no necesitan usar prioridad, pero pueden ordenar colecciones por propiedades ordinarias (consulte Ordenar datos para alternativas a la prioridad).

Firma:

export declare function orderByPriority(): QueryConstraint;

Devoluciones:

Restricción de consulta

ordenPorValor()

Crea una nueva QueryConstraint que ordena por valor.

Si los elementos secundarios de una consulta son todos valores escalares (cadena, número o booleano), puede ordenar los resultados por sus valores (ascendentes).

Puedes leer más sobre orderByValue() en Ordenar datos .

Firma:

export declare function orderByValue(): QueryConstraint;

Devoluciones:

Restricción de consulta

marca de tiempo del servidor()

Devuelve un valor de marcador de posición para completar automáticamente la marca de tiempo actual (tiempo desde la época de Unix, en milisegundos) según lo determinado por los servidores de Firebase.

Firma:

export declare function serverTimestamp(): object;

Devoluciones:

objeto

función(delta,...)

incremento(delta)

Devuelve un valor de marcador de posición que se puede utilizar para incrementar atómicamente el valor de la base de datos actual según el delta proporcionado.

Firma:

export declare function increment(delta: number): object;

Parámetros

Parámetro Tipo Descripción
delta número la cantidad para modificar el valor actual atómicamente.

Devoluciones:

objeto

Un valor de marcador de posición para modificar datos de forma atómica en el lado del servidor.

función (habilitada, ...)

enableLogging(habilitado, persistente)

Registra información de depuración en la consola.

Firma:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

Parámetros

Parámetro Tipo Descripción
activado booleano Habilita el registro si es true , deshabilita el registro si es false .
persistente booleano Recuerda el estado de registro entre actualizaciones de página si es true .

Devoluciones:

cualquier

función(límite, ...)

límiteAPrimero(límite)

Crea una nueva QueryConstraint que se limita al primer número específico de hijos.

El método limitToFirst() se utiliza para establecer un número máximo de elementos secundarios que se sincronizarán para una devolución de llamada determinada. Si establecemos un límite de 100, inicialmente solo recibiremos hasta 100 eventos child_added . Si tenemos menos de 100 mensajes almacenados en nuestra base de datos, se activará un evento child_added para cada mensaje. Sin embargo, si tenemos más de 100 mensajes, solo recibiremos un evento child_added para los primeros 100 mensajes ordenados. A medida que los elementos cambien, recibiremos eventos child_removed por cada elemento que salga de la lista activa para que el número total permanezca en 100.

Puedes leer más sobre limitToFirst() en Filtrado de datos. .

Firma:

export declare function limitToFirst(limit: number): QueryConstraint;

Parámetros

Parámetro Tipo Descripción
límite número El número máximo de nodos que se incluirán en esta consulta.

Devoluciones:

Restricción de consulta

límite al último (límite)

Crea una nueva QueryConstraint que está limitada a devolver solo el último número de hijos especificado.

El método limitToLast() se utiliza para establecer un número máximo de elementos secundarios que se sincronizarán para una devolución de llamada determinada. Si establecemos un límite de 100, inicialmente solo recibiremos hasta 100 eventos child_added . Si tenemos menos de 100 mensajes almacenados en nuestra base de datos, se activará un evento child_added para cada mensaje. Sin embargo, si tenemos más de 100 mensajes, solo recibiremos un evento child_added para los últimos 100 mensajes ordenados. A medida que los elementos cambien, recibiremos eventos child_removed por cada elemento que salga de la lista activa para que el número total permanezca en 100.

Puedes leer más sobre limitToLast() en Filtrado de datos. .

Firma:

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

Parámetros

Parámetro Tipo Descripción
límite número El número máximo de nodos que se incluirán en esta consulta.

Devoluciones:

Restricción de consulta

función(registrador, ...)

enableLogging(registrador)

Registra información de depuración en la consola.

Firma:

export declare function enableLogging(logger: (message: string) => unknown): any;

Parámetros

Parámetro Tipo Descripción
registrador (mensaje: cadena) => desconocido Una función de registro personalizada para controlar cómo se registran las cosas.

Devoluciones:

cualquier

función (padre, ...)

hijo (padre, ruta)

Obtiene una Reference para la ubicación en la ruta relativa especificada.

La ruta relativa puede ser un nombre secundario simple (por ejemplo, "ada") o una ruta más profunda separada por barras (por ejemplo, "ada/nombre/primero").

Firma:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

Parámetros

Parámetro Tipo Descripción
padre Referencia de base de datos La ubicación principal.
camino cadena Una ruta relativa desde esta ubicación hasta la ubicación secundaria deseada.

Devoluciones:

Referencia de base de datos

La ubicación secundaria especificada.

empujar (padre, valor)

Genera una nueva ubicación secundaria usando una clave única y devuelve su Reference .

Este es el patrón más común para agregar datos a una colección de elementos.

Si proporciona un valor para push() , el valor se escribe en la ubicación generada. Si no pasa un valor, no se escribe nada en la base de datos y el elemento secundario permanece vacío (pero puede usar la Reference en otro lugar).

Las claves únicas generadas por push() están ordenadas por hora actual, por lo que la lista resultante de elementos está ordenada cronológicamente. Las claves también están diseñadas para que sean imposibles de adivinar (contienen 72 bits aleatorios de entropía).

Ver Agregar a una lista de datos . Consulte las 2^120 formas de garantizar identificadores únicos .

Firma:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

Parámetros

Parámetro Tipo Descripción
padre Referencia de base de datos La ubicación principal.
valor desconocido Valor opcional que se escribirá en la ubicación generada.

Devoluciones:

Referencia entoncesable

Promise y Reference combinadas ; se resuelve cuando se completa la escritura, pero se puede usar inmediatamente como Reference a la ubicación secundaria.

función (ruta, ...)

ordenPorNiño(ruta)

Crea una nueva QueryConstraint que ordena según la clave secundaria especificada.

Las consultas sólo pueden ordenarse por una clave a la vez. Llamar a orderByChild() varias veces en la misma consulta es un error.

Las consultas de Firebase le permiten ordenar sus datos por cualquier clave secundaria sobre la marcha. Sin embargo, si sabe de antemano cuáles serán sus índices, puede definirlos mediante la regla .indexOn en sus Reglas de seguridad para un mejor rendimiento. Consulte la regla https://firebase.google.com/docs/database/security/indexing-data para obtener más información.

Puedes leer más sobre orderByChild() en Ordenar datos .

Firma:

export declare function orderByChild(path: string): QueryConstraint;

Parámetros

Parámetro Tipo Descripción
camino cadena El camino para ordenar por.

Devoluciones:

Restricción de consulta

función (consulta, ...)

obtener (consulta)

Obtiene el resultado más actualizado para esta consulta.

Firma:

export declare function get(query: Query): Promise<DataSnapshot>;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.

Devoluciones:

Promesa< Instantánea de datos >

Una Promise que se resuelve en la instantánea de datos resultante si hay un valor disponible, o la rechaza si el cliente no puede devolver un valor (por ejemplo, si no se puede acceder al servidor y no hay nada almacenado en caché).

off(consulta, tipo de evento, devolución de llamada)

Separa una devolución de llamada previamente adjunta con el correspondiente on*() ( onValue , onChildAdded ) oyente. Nota: Esta no es la forma recomendada de eliminar un oyente. En su lugar, utilice la función de devolución de llamada devuelta desde las respectivas devoluciones de llamada on* .

Separar una devolución de llamada previamente adjunta con on*() . Llamar a off() en un oyente principal no eliminará automáticamente los oyentes registrados en los nodos secundarios; también se debe llamar off() en cualquier oyente secundario para eliminar la devolución de llamada.

Si no se especifica una devolución de llamada, se eliminarán todas las devoluciones de llamada para el tipo de evento especificado. De manera similar, si no se especifica ningún tipo de evento, se eliminarán todas las devoluciones de llamada de la Reference .

Los oyentes individuales también pueden ser eliminados invocando sus devoluciones de llamada para cancelar la suscripción.

Firma:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta con la que se registró el oyente.
tipo de evento Tipo de evento Una de las siguientes cadenas: "valor", "child_added", "child_changed", "child_removed" o "child_moved". Si se omite, se eliminarán todas las devoluciones de llamada de la Reference .
llamar de vuelta (instantánea: instantánea de datos , ¿NombreNiño anterior?: cadena | nulo) => desconocido La función de devolución de llamada que se pasó a on() o undefined para eliminar todas las devoluciones de llamada.

Devoluciones:

vacío

onChildAdded (consulta, devolución de llamada, cancelar devolución de llamada)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildAdded una vez por cada niño inicial en esta ubicación, y se activará nuevamente cada vez que se agregue un niño nuevo. El DataSnapshot pasado a la devolución de llamada reflejará los datos del niño relevante. Para fines de orden, se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , ¿NombreNiño anterior?: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildAdded(consulta, devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildAdded una vez por cada niño inicial en esta ubicación, y se activará nuevamente cada vez que se agregue un niño nuevo. El DataSnapshot pasado a la devolución de llamada reflejará los datos del niño relevante. Para fines de orden, se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , nombre de niño anterior: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildAdded (consulta, devolución de llamada, cancelar devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildAdded una vez por cada niño inicial en esta ubicación, y se activará nuevamente cada vez que se agregue un niño nuevo. El DataSnapshot pasado a la devolución de llamada reflejará los datos del niño relevante. Para fines de orden, se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , nombre de niño anterior: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildChanged (consulta, devolución de llamada, cancelar devolución de llamada)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildChanged cuando cambien los datos almacenados en un niño (o cualquiera de sus descendientes). Tenga en cuenta que un único evento child_changed puede representar múltiples cambios para el niño. El DataSnapshot pasado a la devolución de llamada contendrá el nuevo contenido secundario. Para fines de orden, a la devolución de llamada también se le pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , nombre de niño anterior: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildChanged (consulta, devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildChanged cuando cambien los datos almacenados en un niño (o cualquiera de sus descendientes). Tenga en cuenta que un único evento child_changed puede representar múltiples cambios para el niño. El DataSnapshot pasado a la devolución de llamada contendrá el nuevo contenido secundario. Para fines de orden, a la devolución de llamada también se le pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , nombre de niño anterior: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildChanged (consulta, devolución de llamada, cancelar devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildChanged cuando cambien los datos almacenados en un niño (o cualquiera de sus descendientes). Tenga en cuenta que un único evento child_changed puede representar múltiples cambios para el niño. El DataSnapshot pasado a la devolución de llamada contendrá el nuevo contenido secundario. Para fines de orden, a la devolución de llamada también se le pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , nombre de niño anterior: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildMoved (consulta, devolución de llamada, cancelar devolución de llamada)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildMoved cuando el orden de clasificación de un niño cambie de modo que cambie su posición relativa a sus hermanos. El DataSnapshot pasado a la devolución de llamada será para los datos del niño que se ha movido. También se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , nombre de niño anterior: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildMoved(consulta, devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildMoved cuando el orden de clasificación de un niño cambie de modo que cambie su posición relativa a sus hermanos. El DataSnapshot pasado a la devolución de llamada será para los datos del niño que se ha movido. También se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , nombre de niño anterior: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildMoved (consulta, devolución de llamada, cancelar devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildMoved cuando el orden de clasificación de un niño cambie de modo que cambie su posición relativa a sus hermanos. El DataSnapshot pasado a la devolución de llamada será para los datos del niño que se ha movido. También se pasa un segundo argumento que es una cadena que contiene la clave del hermano anterior por orden de clasificación, o null si es el primer hijo.

Firma:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos , nombre de niño anterior: cadena | nulo) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildRemoved (consulta, devolución de llamada, cancelar devolución de llamada)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildRemoved cada vez que se elimine un niño. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del niño que se eliminó. Un niño será retirado cuando:

  • un cliente llama explícitamente remove() en ese niño o en uno de sus antepasados ​​- un cliente llama a set(null) en ese niño o en uno de sus antepasados ​​- a ese niño se le eliminan todos sus hijos - hay una consulta vigente que ahora filtra eliminar al niño (porque se cambió el orden de clasificación o se alcanzó el límite máximo)

Firma:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos ) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildRemoved(consulta, devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildRemoved cada vez que se elimine un niño. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del niño que se eliminó. Un niño será retirado cuando:

  • un cliente llama explícitamente remove() en ese niño o en uno de sus antepasados ​​- un cliente llama a set(null) en ese niño o en uno de sus antepasados ​​- a ese niño se le eliminan todos sus hijos - hay una consulta vigente que ahora filtra eliminar al niño (porque se cambió el orden de clasificación o se alcanzó el límite máximo)

Firma:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos ) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onChildRemoved (consulta, devolución de llamada, cancelar devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Se activará un evento onChildRemoved cada vez que se elimine un niño. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del niño que se eliminó. Un niño será retirado cuando:

  • un cliente llama explícitamente remove() en ese niño o en uno de sus antepasados ​​- un cliente llama a set(null) en ese niño o en uno de sus antepasados ​​- a ese niño se le eliminan todos sus hijos - hay una consulta vigente que ahora filtra eliminar al niño (porque se cambió el orden de clasificación o se alcanzó el límite máximo)

Firma:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos ) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos y una cadena que contiene la clave del hijo anterior, por orden de clasificación, o null si es el primer hijo.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onValue (consulta, devolución de llamada, cancelar devolución de llamada)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Un evento onValue se activará una vez con los datos iniciales almacenados en esta ubicación y luego se activará nuevamente cada vez que los datos cambien. El DataSnapshot pasado a la devolución de llamada será para la ubicación en la que se llamó on() . No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con una DataSnapshot vacía ( val() devolverá null ).

Firma:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos ) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onValue (consulta, devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Un evento onValue se activará una vez con los datos iniciales almacenados en esta ubicación y luego se activará nuevamente cada vez que los datos cambien. El DataSnapshot pasado a la devolución de llamada será para la ubicación en la que se llamó on() . No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con una DataSnapshot vacía ( val() devolverá null ).

Firma:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos ) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

onValue (consulta, devolución de llamada, cancelar devolución de llamada, opciones)

Escucha cambios de datos en una ubicación particular.

Esta es la forma principal de leer datos de una base de datos. Su devolución de llamada se activará para los datos iniciales y nuevamente cada vez que los datos cambien. Invoque la devolución de llamada de cancelación de suscripción devuelta para dejar de recibir actualizaciones. Consulte Recuperar datos en la Web para obtener más detalles.

Un evento onValue se activará una vez con los datos iniciales almacenados en esta ubicación y luego se activará nuevamente cada vez que los datos cambien. El DataSnapshot pasado a la devolución de llamada será para la ubicación en la que se llamó on() . No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con una DataSnapshot vacía ( val() devolverá null ).

Firma:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La consulta a ejecutar.
llamar de vuelta (instantánea: instantánea de datos ) => desconocido Una devolución de llamada que se activa cuando ocurre el evento especificado. A la devolución de llamada se le pasará una instantánea de datos.
cancelarDevolución de llamada (error: Error) => desconocido Una devolución de llamada opcional que se notificará si alguna vez se cancela su suscripción al evento porque su cliente no tiene permiso para leer estos datos (o tenía permiso pero ahora lo ha perdido). A esta devolución de llamada se le pasará un objeto Error que indica por qué ocurrió la falla.
opciones Opciones de escucha Un objeto que se puede usar para configurar onlyOnce , que luego elimina el oyente después de su primera invocación.

Devoluciones:

Darse de baja

Una función que se puede invocar para eliminar al oyente.

consulta (consulta, consultaRestricciones)

Crea una nueva instancia inmutable de Query que se extiende para incluir también restricciones de consulta adicionales.

Firma:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

Parámetros

Parámetro Tipo Descripción
consulta Consulta La instancia de Query que se utilizará como base para las nuevas restricciones.
restricciones de consulta Restricción de consulta [] La lista de QueryConstraint que se aplicarán.

Devoluciones:

Consulta

Excepciones

si alguna de las restricciones de consulta proporcionadas no se puede combinar con las restricciones existentes o nuevas.

función(referencia, ...)

al desconectar (ref)

Devuelve un objeto OnDisconnect ; consulte Habilitación de capacidades sin conexión en JavaScript para obtener más información sobre cómo usarlo.

Firma:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

Parámetros

Parámetro Tipo Descripción
árbitro Referencia de base de datos La referencia para agregar activadores OnDisconnect.

Devoluciones:

Al desconectar

eliminar (referencia)

Elimina los datos en esta ubicación de la base de datos.

También se eliminarán todos los datos en las ubicaciones de los niños.

El efecto de la eliminación será visible inmediatamente y se activará el 'valor' del evento correspondiente. También se iniciará la sincronización de la eliminación con los servidores de Firebase y la Promesa devuelta se resolverá cuando se complete. Si se proporciona, la devolución de llamada onComplete se llamará de forma asincrónica una vez finalizada la sincronización.

Firma:

export declare function remove(ref: DatabaseReference): Promise<void>;

Parámetros

Parámetro Tipo Descripción
árbitro Referencia de base de datos La ubicación a eliminar.

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la eliminación en el servidor.

ejecutarTransacción(ref, actualización de transacción, opciones)

Modifica atómicamente los datos en esta ubicación.

Modifique atómicamente los datos en esta ubicación. A diferencia de un set() , que simplemente sobrescribe los datos independientemente de su valor anterior, runTransaction() se usa para modificar el valor existente a un valor nuevo, asegurando que no haya conflictos con otros clientes que escriben en la misma ubicación al mismo tiempo.

Para lograr esto, pasa runTransaction() una función de actualización que se utiliza para transformar el valor actual en un nuevo valor. Si otro cliente escribe en la ubicación antes de que su nuevo valor se escriba correctamente, se llamará nuevamente a su función de actualización con el nuevo valor actual y se volverá a intentar la escritura. Esto sucederá repetidamente hasta que su escritura se realice correctamente sin conflictos o cancele la transacción al no devolver un valor de su función de actualización.

Firma:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

Parámetros

Parámetro Tipo Descripción
árbitro Referencia de base de datos La ubicación para modificar atómicamente.
transacciónActualización (datos actuales: cualquiera) => desconocido Una función proporcionada por el desarrollador a la que se le pasarán los datos actuales almacenados en esta ubicación (como un objeto JavaScript). La función debe devolver el nuevo valor que desea escribir (como un objeto JavaScript). Si se devuelve undefined (es decir, regresa sin argumentos), la transacción se cancelará y los datos en esta ubicación no se modificarán.
opciones Opciones de transacción Un objeto de opciones para configurar transacciones.

Devoluciones:

Promesa < Resultado de la transacción >

Una Promise que se puede usar opcionalmente en lugar de la devolución de llamada onComplete para controlar el éxito y el fracaso.

establecer (ref, valor)

Escribe datos en esta ubicación de base de datos.

Esto sobrescribirá cualquier dato en esta ubicación y en todas las ubicaciones secundarias.

El efecto de la escritura será visible inmediatamente y se activarán los eventos correspondientes ("valor", "child_added", etc.). También se iniciará la sincronización de los datos con los servidores de Firebase y la Promesa devuelta se resolverá cuando se complete. Si se proporciona, la devolución de llamada onComplete se llamará de forma asincrónica una vez finalizada la sincronización.

Pasar null para el nuevo valor es equivalente a llamar remove() ; es decir, se eliminarán todos los datos de esta ubicación y todas las ubicaciones secundarias.

set() eliminará cualquier prioridad almacenada en esta ubicación, por lo que si se desea conservar la prioridad, debe usar setWithPriority() en su lugar.

Tenga en cuenta que modificar datos con set() cancelará cualquier transacción pendiente en esa ubicación, por lo que se debe tener mucho cuidado al mezclar set() y transaction() para modificar los mismos datos.

Un solo set() generará un único evento de "valor" en la ubicación donde se realizó el set() .

Firma:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

Parámetros

Parámetro Tipo Descripción
árbitro Referencia de base de datos La ubicación para escribir.
valor desconocido El valor que se va a escribir (cadena, número, booleano, objeto, matriz o nulo).

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la escritura en el servidor.

establecerPrioridad(ref, prioridad)

Establece una prioridad para los datos en esta ubicación de la base de datos.

Las aplicaciones no necesitan usar prioridad, pero pueden ordenar colecciones según propiedades ordinarias (consulte Ordenar y filtrar datos ).

Firma:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

Parámetros

Parámetro Tipo Descripción
árbitro Referencia de base de datos La ubicación para escribir.
prioridad cadena | número | nulo La prioridad que se va a escribir (cadena, número o nulo).

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la escritura en el servidor.

setWithPriority(ref, valor, prioridad)

Escribe datos en la ubicación de la base de datos. Como set() pero también especifica la prioridad de esos datos.

Las aplicaciones no necesitan usar prioridad, pero pueden ordenar colecciones según propiedades ordinarias (consulte Ordenar y filtrar datos ).

Firma:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

Parámetros

Parámetro Tipo Descripción
árbitro Referencia de base de datos La ubicación para escribir.
valor desconocido El valor que se va a escribir (cadena, número, booleano, objeto, matriz o nulo).
prioridad cadena | número | nulo La prioridad que se va a escribir (cadena, número o nulo).

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la escritura en el servidor.

actualizar (ref, valores)

Escribe varios valores en la base de datos a la vez.

El argumento values contiene varios pares de propiedad-valor que se escribirán juntos en la base de datos. Cada propiedad secundaria puede ser una propiedad simple (por ejemplo, "nombre") o una ruta relativa (por ejemplo, "nombre/primero") desde la ubicación actual hasta los datos que se van a actualizar.

A diferencia del método set() , update() se puede utilizar para actualizar selectivamente solo las propiedades a las que se hace referencia en la ubicación actual (en lugar de reemplazar todas las propiedades secundarias en la ubicación actual).

El efecto de la escritura será visible inmediatamente y se activarán los eventos correspondientes ('valor', 'child_added', etc.). También se iniciará la sincronización de los datos con los servidores de Firebase y la Promesa devuelta se resolverá cuando se complete. Si se proporciona, la devolución de llamada onComplete se llamará de forma asincrónica una vez finalizada la sincronización.

Una sola update() generará un único evento de "valor" en la ubicación donde se realizó la update() , independientemente de cuántos elementos secundarios se modificaron.

Tenga en cuenta que modificar datos con update() cancelará cualquier transacción pendiente en esa ubicación, por lo que se debe tener mucho cuidado al mezclar update() y transaction() para modificar los mismos datos.

Pasar null a update() eliminará los datos en esta ubicación.

Ver Presentación de actualizaciones para múltiples ubicaciones y más .

Firma:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

Parámetros

Parámetro Tipo Descripción
árbitro Referencia de base de datos La ubicación para escribir.
valores objeto Objeto que contiene múltiples valores.

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la actualización en el servidor.

función(valor,...)

endAt(valor, clave)

Crea una QueryConstraint con el punto final especificado.

Usando startAt() , startAfter() , endBefore() , endAt() y equalTo() le permiten elegir puntos de inicio y finalización arbitrarios para sus consultas.

El punto final es inclusivo, por lo que los niños con exactamente el valor especificado se incluirán en la consulta. El argumento clave opcional se puede utilizar para limitar aún más el rango de la consulta. Si se especifica, los hijos que tienen exactamente el valor especificado también deben tener un nombre de clave menor o igual a la clave especificada.

Puedes leer más sobre endAt() en Filtrado de datos. .

Firma:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

Parámetros

Parámetro Tipo Descripción
valor número | cadena | booleano | nulo El valor al que terminar. El tipo de argumento depende de qué función orderBy () se utilizó en esta consulta. Especifique un valor que coincida con el tipo orderBy () . Cuando se usa en combinación con orderByKey() , el valor debe ser una cadena.
llave cadena La clave secundaria en la que finalizar, entre los hijos con la prioridad especificada previamente. Este argumento solo se permite si se ordena por hijo, valor o prioridad.

Devoluciones:

Restricción de consulta

endBefore(valor, clave)

Crea una QueryConstraint con el punto final especificado (exclusivo).

Usando startAt() , startAfter() , endBefore() , endAt() y equalTo() le permiten elegir puntos de inicio y finalización arbitrarios para sus consultas.

El punto final es exclusivo. Si solo se proporciona un valor, los niños con un valor menor que el valor especificado se incluirán en la consulta. Si se especifica una clave, los hijos deben tener un valor menor o igual al valor especificado y un nombre de clave menor que la clave especificada.

Firma:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

Parámetros

Parámetro Tipo Descripción
valor número | cadena | booleano | nulo El valor para terminar antes. El tipo de argumento depende de qué función orderBy () se utilizó en esta consulta. Especifique un valor que coincida con el tipo orderBy () . Cuando se usa en combinación con orderByKey() , el valor debe ser una cadena.
llave cadena La clave secundaria para finalizar antes, entre los hijos con la prioridad previamente especificada. Este argumento solo se permite si se ordena por hijo, valor o prioridad.

Devoluciones:

Restricción de consulta

igual a (valor, clave)

Crea una QueryConstraint que incluye elementos secundarios que coinciden con el valor especificado.

Usando startAt() , startAfter() , endBefore() , endAt() y equalTo() le permiten elegir puntos de inicio y finalización arbitrarios para sus consultas.

El argumento clave opcional se puede utilizar para limitar aún más el rango de la consulta. Si se especifica, los hijos que tienen exactamente el valor especificado también deben tener exactamente la clave especificada como nombre de clave. Esto se puede utilizar para filtrar conjuntos de resultados con muchas coincidencias para el mismo valor.

Puedes leer más sobre equalTo() en Filtrado de datos. .

Firma:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

Parámetros

Parámetro Tipo Descripción
valor número | cadena | booleano | nulo El valor a igualar. El tipo de argumento depende de qué función orderBy () se utilizó en esta consulta. Especifique un valor que coincida con el tipo orderBy () . Cuando se usa en combinación con orderByKey() , el valor debe ser una cadena.
llave cadena La clave secundaria por la que comenzar, entre los hijos con la prioridad especificada previamente. Este argumento solo se permite si se ordena por hijo, valor o prioridad.

Devoluciones:

Restricción de consulta

startAfter(valor, clave)

Crea una QueryConstraint con el punto de partida especificado (exclusivo).

Usando startAt() , startAfter() , endBefore() , endAt() y equalTo() le permiten elegir puntos de inicio y finalización arbitrarios para sus consultas.

El punto de partida es exclusivo. Si solo se proporciona un valor, los niños con un valor mayor que el valor especificado se incluirán en la consulta. Si se especifica una clave, los hijos deben tener un valor mayor o igual que el valor especificado y un nombre de clave mayor que la clave especificada.

Firma:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

Parámetros

Parámetro Tipo Descripción
valor número | cadena | booleano | nulo El valor para comenzar después. El tipo de argumento depende de qué función orderBy () se utilizó en esta consulta. Especifique un valor que coincida con el tipo orderBy () . Cuando se usa en combinación con orderByKey() , el valor debe ser una cadena.
llave cadena La clave infantil para empezar después. Este argumento solo se permite si se ordena por hijo, valor o prioridad.

Devoluciones:

Restricción de consulta

inicioEn(valor, clave)

Crea una QueryConstraint con el punto de partida especificado.

Usando startAt() , startAfter() , endBefore() , endAt() y equalTo() le permiten elegir puntos de inicio y finalización arbitrarios para sus consultas.

El punto de partida es inclusivo, por lo que los niños con exactamente el valor especificado se incluirán en la consulta. El argumento clave opcional se puede utilizar para limitar aún más el rango de la consulta. Si se especifica, los hijos que tienen exactamente el valor especificado también deben tener un nombre de clave mayor o igual a la clave especificada.

Puedes leer más sobre startAt() en Filtrado de datos. .

Firma:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

Parámetros

Parámetro Tipo Descripción
valor número | cadena | booleano | nulo El valor para empezar. El tipo de argumento depende de qué función orderBy () se utilizó en esta consulta. Especifique un valor que coincida con el tipo orderBy () . Cuando se usa en combinación con orderByKey() , el valor debe ser una cadena.
llave cadena La clave infantil para empezar. Este argumento solo se permite si se ordena por hijo, valor o prioridad.

Devoluciones:

Restricción de consulta

Tipo de evento

Una de las siguientes cadenas: "valor", "child_added", "child_changed", "child_removed" o "child_moved".

Firma:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

Tipo de restricción de consulta

Describe las diferentes restricciones de consulta disponibles en este SDK.

Firma:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

Darse de baja

Una devolución de llamada que se puede invocar para eliminar a un oyente.

Firma:

export declare type Unsubscribe = () => void;