Firebase Realtime Database
Funciones
| Función | Descripción |
|---|---|
| function(app, ...) | |
| getDatabase(app, url) | Muestra la instancia del SDK de Realtime Database asociada con la FirebaseApp proporcionada. Inicializa una instancia nueva con configuración predeterminada si no existe una instancia o si la instancia existente utiliza una URL de base de datos personalizada. |
| function(db, ...) | |
| connectDatabaseEmulator(db, host, puerto, opciones) | Modifica la instancia proporcionada para que se comunique con el emulador de Realtime Database. Nota: Se debe llamar a este método antes de realizar cualquier otra operación. |
| goOffline(db) | Se desconecta del servidor (todas las operaciones de Database se completarán sin conexión).El cliente mantiene automáticamente una conexión persistente con el servidor de Database, que permanecerá activo de forma indefinida y se volverá a conectar cuando se desconecte. Sin embargo, se pueden usar los métodos goOffline() y goOnline() para controlar la conexión del cliente en los casos en que una conexión persistente no es deseable.Mientras esté sin conexión, el cliente ya no recibirá actualizaciones de datos de la base de datos. Sin embargo, todas las operaciones de la base de datos que se realizan de forma local seguirán activando eventos de forma inmediata, lo que permitirá que la aplicación continúe comportándose con normalidad. Además, cada operación realizada de manera local se pondrá en cola automáticamente y se volverá a intentar tras conectarse al servidor de la base de datos.Para volver a conectarte a la base de datos y comenzar a recibir eventos remotos, consulta goOnline(). |
| goOnline(db) | Se vuelve a conectar al servidor y sincroniza el estado de la base de datos sin conexión con el estado del servidor.Se debe usar este método después de inhabilitar la conexión activa con goOffline(). Una vez que se recupere la conexión, el cliente transmitirá los datos correctos y activará los eventos correspondientes para que el cliente se "ponga al día" automáticamente. |
| ref(db, ruta) | Muestra una Reference que representa la ubicación en la base de datos que corresponde a la ruta de acceso proporcionada. Si no se proporciona una ruta de acceso, Reference apuntará a la raíz de la base de datos. |
| refFromURL(db, url) | Muestra una Reference que representa la ubicación en la base de datos correspondiente a la URL de Firebase proporcionada.Se arroja una excepción si la URL no es una URL válida de Firebase Database o si tiene un dominio diferente al de la instancia actual de Database.Ten en cuenta que todos los parámetros de búsqueda (orderBy, limitToLast, etc.) se ignoran y no se aplican al elemento Reference que se muestra. |
| function() | |
| forceLongPolling() | Fuerza el uso de longPolling en lugar de websockets. Se ignorará si se usa el protocolo websocket en databaseURL. |
| forceWebSockets() | Fuerza el uso de websockets en lugar de longPolling. |
| orderByKey() | Crea una QueryConstraint nueva que ordena por clave.Ordena los resultados de una consulta por sus valores de clave (ascendentes).Puedes obtener más información sobre orderByKey() en Ordenar datos. |
| orderByPriority() | Crea un QueryConstraint nuevo que ordena los datos por prioridad.Las aplicaciones no necesitan usar la prioridad, pero pueden ordenar las colecciones por propiedades comunes (consulta Ordenar datos para conocer las alternativas a la prioridad. |
| orderByValue() | Crea un nuevo elemento QueryConstraint que ordena por valor.Si los elementos secundarios de una consulta son todos valores escalares (string, número o booleano), puedes ordenar los resultados por sus valores (ascendentes).Puedes obtener más información sobre orderByValue() en Ordenar datos. |
| serverTimestamp() | Devuelve un valor de marcador de posición para propagar automáticamente la marca de tiempo actual (tiempo desde el tiempo Unix, en milisegundos) según lo determinan los servidores de Firebase. |
| function(delta, ...) | |
| increment(delta) | Muestra un valor de marcador de posición que se puede usar para aumentar de forma atómica el valor actual de la base de datos según el delta proporcionado. |
| function(enabled, ...) | |
| enableLogging(habilitado, persistente) | Registra la información de depuración en la consola. |
| function(limit, ...) | |
| limitToFirst(limit) | Crea un QueryConstraint nuevo que, si se limita a la primera cantidad específica de elementos secundarios.Se usa el método limitToFirst() para establecer una cantidad máxima de elementos secundarios que se sincronizarán para una devolución de llamada determinada. Si establecemos un límite de 100, inicialmente solo obtendremos un máximo de 100 eventos de child_added. Si tenemos menos de 100 mensajes almacenados en nuestra base de datos, se activará un evento child_added por cada uno de ellos. Sin embargo, si tenemos más de 100 mensajes, solo recibiremos un evento child_added para los primeros 100 mensajes ordenados. A medida que cambien los elementos, recibiremos child_removed eventos por cada elemento que quede fuera de la lista activa, de modo que la cantidad total siga siendo 100.Puedes obtener más información sobre limitToFirst() en Cómo filtrar datos. |
| limitToLast(limit) | Crea un QueryConstraint nuevo que se limita a mostrar solo la última cantidad especificada de elementos secundarios.Se usa el método limitToLast() para establecer una cantidad máxima de elementos secundarios que se sincronizarán para una devolución de llamada determinada. Si establecemos un límite de 100, inicialmente solo obtendremos un máximo de 100 eventos de child_added. Si tenemos menos de 100 mensajes almacenados en nuestra base de datos, se activará un evento child_added por cada uno de ellos. Sin embargo, si tenemos más de 100 mensajes, solo recibiremos un evento child_added para los últimos 100 mensajes ordenados. A medida que cambien los elementos, recibiremos child_removed eventos por cada elemento que quede fuera de la lista activa, de modo que la cantidad total siga siendo 100.Puedes obtener más información sobre limitToLast() en Cómo filtrar datos. |
| function(registrador, ...) | |
| enableLogging(registrador) | Registra la información de depuración en la consola. |
| function(parent, ...) | |
| secundario(principal, ruta de acceso) | Obtiene un 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 de acceso separada por barras más profundas (por ejemplo, "ada/name/first"). |
| push(elemento superior, valor) | Genera una ubicación secundaria nueva con una clave única y muestra su Reference.Este es el patrón más común para agregar datos a una colección de elementos.Si proporcionas un valor para push(), el valor se escribe en la ubicación generada. Si no pasas un valor, no se escribe nada en la base de datos y el elemento secundario permanece vacío (pero puedes usar Reference en otro lugar).Las claves únicas que genera push() se ordenan según la hora actual, de modo que la lista resultante de elementos se ordena de forma cronológica. Las claves también están diseñadas para ser indescifrables (contienen 72 bits aleatorios de entropía).Consulta Agregar a una lista de datos. Consulta Las 2^120 formas de garantizar identificadores únicos. |
| función(ruta, ...) | |
| orderByChild(ruta) | Crea un QueryConstraint nuevo que ordena según la clave secundaria especificada.Las consultas solo pueden ordenarse por una clave a la vez. Llamar a orderByChild() varias veces en la misma consulta es un error.Las consultas de Firebase te permiten ordenar tus datos en función de cualquier clave secundaria sobre la marcha. Sin embargo, si sabes de antemano cuáles serán tus índices, puedes definirlos a través de la regla .indexOn en tus reglas de seguridad para obtener un mejor rendimiento. Consulta la regla https://firebase.google.com/docs/database/security/indexing-data para obtener más información.Puedes obtener más información sobre orderByChild() en Cómo ordenar datos. |
| function(query, ...) | |
| get(consulta) | Obtiene el resultado más actualizado para esta consulta. |
| off(consulta, eventType, devolución de llamada) | Desconecta una devolución de llamada que se adjuntó anteriormente con el objeto de escucha on() (onValue, onChildAdded) correspondiente. Nota: Esta no es la forma recomendada de quitar un objeto de escucha. En su lugar, usa la función de devolución de llamada que se muestra desde las devoluciones de llamada correspondientes on.Desconecta una devolución de llamada que antes se adjuntó con on*(). Si llamas a off() en un objeto de escucha superior, no se quitarán automáticamente los objetos de escucha registrados en los nodos secundarios. También se debe llamar a off() en todos los objetos de escucha secundarios para quitar la devolución de llamada.Si no se especifica una devolución de llamada, se quitarán todas las devoluciones de llamada para el eventType especificado. De manera similar, si no se especifica un eventType, se quitarán todas las devoluciones de llamada para Reference.También se pueden quitar los objetos de escucha individuales invocando las devoluciones de llamada para anular la suscripción. |
| onChildAdded(consulta, devolución de llamada, cancelCallback) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más información.Se activará un evento onChildAdded una vez por cada elemento secundario inicial en esta ubicación y cada vez que se agregue un nuevo elemento secundario. La DataSnapshot que se pase a la devolución de llamada reflejará los datos del elemento secundario relevante. Para ordenar, se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildAdded(consulta, devolución de llamada, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más información.Se activará un evento onChildAdded una vez por cada elemento secundario inicial en esta ubicación y cada vez que se agregue un nuevo elemento secundario. La DataSnapshot que se pase a la devolución de llamada reflejará los datos del elemento secundario relevante. Para ordenar, se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildAdded(consulta, devolución de llamada, cancelCallback, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más información.Se activará un evento onChildAdded una vez por cada elemento secundario inicial en esta ubicación y cada vez que se agregue un nuevo elemento secundario. La DataSnapshot que se pase a la devolución de llamada reflejará los datos del elemento secundario relevante. Para ordenar, se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildChanged(consulta, devolución de llamada, cancelCallback) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onChildChanged cuando cambien los datos almacenados en un elemento secundario (o cualquiera de sus elementos subordinados). Ten en cuenta que un solo evento child_changed puede representar varios cambios en el elemento secundario. La DataSnapshot pasada a la devolución de llamada contendrá el nuevo contenido secundario. Para ordenar, la devolución de llamada también recibe un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildChanged(consulta, devolución de llamada, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onChildChanged cuando cambien los datos almacenados en un elemento secundario (o cualquiera de sus elementos subordinados). Ten en cuenta que un solo evento child_changed puede representar varios cambios en el elemento secundario. La DataSnapshot pasada a la devolución de llamada contendrá el nuevo contenido secundario. Para ordenar, la devolución de llamada también recibe un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildChanged(consulta, devolución de llamada, cancelCallback, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onChildChanged cuando cambien los datos almacenados en un elemento secundario (o cualquiera de sus elementos subordinados). Ten en cuenta que un solo evento child_changed puede representar varios cambios en el elemento secundario. La DataSnapshot pasada a la devolución de llamada contendrá el nuevo contenido secundario. Para ordenar, la devolución de llamada también recibe un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildMove(consulta, devolución de llamada, cancelCallback) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onChildMoved cuando cambie el orden de clasificación de un elemento secundario, de modo que cambie su posición respecto de los elementos del mismo nivel. El DataSnapshot pasado a la devolución de llamada será para los datos del elemento secundario que se movió. También se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildMove(consulta, devolución de llamada, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onChildMoved cuando cambie el orden de clasificación de un elemento secundario, de modo que cambie su posición respecto de los elementos del mismo nivel. El DataSnapshot pasado a la devolución de llamada será para los datos del elemento secundario que se movió. También se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildMove(consulta, devolución de llamada, cancelCallback, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onChildMoved cuando cambie el orden de clasificación de un elemento secundario, de modo que cambie su posición respecto de los elementos del mismo nivel. El DataSnapshot pasado a la devolución de llamada será para los datos del elemento secundario que se movió. También se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario. |
| onChildRemoved(consulta, devolución de llamada, cancelCallback) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más información.Se activará un evento onChildRemoved cada vez que se quite un publicador secundario. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del elemento secundario que se quitó. Se quitará un elemento secundario en estos casos:- Un cliente llama explícitamente a remove() en ese elemento secundario o uno de sus elementos principales; un cliente llama a set(null) en ese elemento secundario o en uno de sus principales; se quitaron todos los elementos secundarios de ese elemento secundario; hay una consulta en curso que ahora filtra el elemento secundario (porque cambió su orden de clasificación o alcanzó el límite máximo). |
| onChildRemoved(consulta, devolución de llamada, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más información.Se activará un evento onChildRemoved cada vez que se quite un publicador secundario. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del elemento secundario que se quitó. Se quitará un elemento secundario en estos casos:- Un cliente llama explícitamente a remove() en ese elemento secundario o uno de sus elementos principales; un cliente llama a set(null) en ese elemento secundario o en uno de sus principales; se quitaron todos los elementos secundarios de ese elemento secundario; hay una consulta en curso que ahora filtra el elemento secundario (porque cambió su orden de clasificación o alcanzó el límite máximo). |
| onChildRemoved(consulta, devolución de llamada, cancelCallback, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más información.Se activará un evento onChildRemoved cada vez que se quite un publicador secundario. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del elemento secundario que se quitó. Se quitará un elemento secundario en estos casos:- Un cliente llama explícitamente a remove() en ese elemento secundario o uno de sus elementos principales; un cliente llama a set(null) en ese elemento secundario o en uno de sus principales; se quitaron todos los elementos secundarios de ese elemento secundario; hay una consulta en curso que ahora filtra el elemento secundario (porque cambió su orden de clasificación o alcanzó el límite máximo). |
| onValue(consulta, devolución de llamada, cancelCallback) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onValue una vez con los datos iniciales almacenados en esta ubicación y, luego, se volverá a activar cada vez que los datos cambien. El DataSnapshot que se pasa a la devolución de llamada será para la ubicación en la que se llamó a on(). No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con un elemento DataSnapshot vacío (val() mostrará null). |
| onValue(consulta, devolución de llamada, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onValue una vez con los datos iniciales almacenados en esta ubicación y, luego, se volverá a activar cada vez que los datos cambien. El DataSnapshot que se pasa a la devolución de llamada será para la ubicación en la que se llamó a on(). No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con un elemento DataSnapshot vacío (val() mostrará null). |
| onValue(consulta, devolución de llamada, cancelCallback, opciones) | Detecta cambios en los datos en una ubicación particular.Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.Se activará un evento onValue una vez con los datos iniciales almacenados en esta ubicación y, luego, se volverá a activar cada vez que los datos cambien. El DataSnapshot que se pasa a la devolución de llamada será para la ubicación en la que se llamó a on(). No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con un elemento DataSnapshot vacío (val() mostrará null). |
| query(query, queryConstraints) | Crea una nueva instancia inmutable de Query que se extiende para incluir también restricciones de consulta adicionales. |
| function(ref, ...) | |
| onDisconnect(ref) | Muestra un objeto OnDisconnect. Consulta Cómo habilitar funciones sin conexión en JavaScript para obtener más información sobre cómo usarlo. |
| remove(ref) | Quita los datos de esta ubicación de la base de datos.También se borrarán todos los datos de las ubicaciones secundarias.El efecto de la eliminación será visible de inmediato y el "valor" del evento correspondiente se activará. También se iniciará la sincronización de la eliminación con los servidores de Firebase y la promesa que se muestra se resolverá cuando se complete. Si se proporciona, se llamará a la devolución de llamada onComplete de forma asíncrona después de que finalice la sincronización. |
| runTransaction(ref, transactionUpdate, opciones) | Modifica los datos de esta ubicación de forma atómica.Modifica los datos de forma atómica en esta ubicación. A diferencia de una set() normal, que solo reemplaza los datos sin importar su valor anterior, runTransaction() se usa para modificar el valor existente en un valor nuevo, lo que garantiza que no haya conflictos con otros clientes que escriben en la misma ubicación al mismo tiempo.Para lograr esto, pasas a runTransaction() una función de actualización que se usa para transformar el valor actual en un valor nuevo. Si otro cliente escribe en la ubicación antes de que el nuevo valor se escriba correctamente, se volverá a llamar a la función de actualización con el nuevo valor actual y se volverá a intentar la escritura. Esto sucederá de forma repetida hasta que la escritura se realice de forma correcta sin que se generen conflictos o hasta que anules la transacción si no devuelves un valor de la función de actualización.Nota: Si modificas datos con set(), se cancelarán las transacciones pendientes en esa ubicación, por lo que debes tener mucho cuidado si combinas set() y runTransaction() para actualizar los mismos datos.Nota: Cuando uses transacciones con reglas de seguridad y Firebase implementadas, ten en cuenta que un cliente necesita acceso .read además del acceso .write para realizar una transacción. Esto se debe a que la naturaleza del cliente de las transacciones requiere que el cliente lea los datos para actualizarlos de forma transaccional. |
| set(ref, valor) | Escribe datos en esta ubicación de la base de datos.Esto reemplazará todos los datos en esta ubicación y en todas las ubicaciones secundarias.El efecto de la escritura se verá de inmediato y se activarán los eventos correspondientes ("value", "child_added", etc.). También se iniciará la sincronización de los datos con los servidores de Firebase y la promesa que se muestra se resolverá cuando se complete. Si se proporciona, se llamará a la devolución de llamada onComplete de forma asíncrona después de que finalice la sincronización.Pasar null para el valor nuevo equivale a llamar a remove(). Es decir, se borrarán todos los datos de esta ubicación y todas las ubicaciones secundarias.set() quitará cualquier prioridad almacenada en esta ubicación, por lo que, si se pretende conservar la prioridad, deberás usar setWithPriority() en su lugar.Ten en cuenta que, si modificas los datos con set(), se cancelarán todas las transacciones pendientes en esa ubicación, por lo que se debe tener mucho cuidado si se combinan set() y transaction() para modificar los mismos datos.Un solo set() generará un solo “valor” en el lugar donde se realizó la set(). |
| setPriority(ref, priority) | Establece una prioridad para los datos en esta ubicación de la base de datos.Las aplicaciones no necesitan usar la prioridad, pero pueden ordenar las colecciones por propiedades comunes (consulta Ordenar y filtrar datos). |
| setWithPriority(ref, valor, prioridad) | Escribe datos en la ubicación de la base de datos. Es similar a set(), pero también especifica la prioridad para esos datos.Las aplicaciones no necesitan usar la prioridad, pero pueden ordenar las colecciones por propiedades comunes (consulta Ordenar y filtrar datos). |
| update(ref, valores) | Escribe varios valores en la base de datos a la vez.El argumento values contiene varios pares 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/nombre") de la ubicación actual a los datos que se actualizarán.A diferencia del método set(), update() se puede usar para actualizar de manera selectiva 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 propiedad secundaria en la ubicación actual se verá de inmediato y se activarán los eventos correspondientes ('child_value') y se activarán de inmediato ('child_value'), y se activarán También se iniciará la sincronización de los datos con los servidores de Firebase y la promesa que se muestra se resolverá cuando se complete. Si se proporciona, se llamará a la devolución de llamada onComplete de forma asíncrona después de que finalice la sincronización.Un solo update() generará un solo "valor" en la ubicación en la que se realizó la update(), sin importar cuántos elementos secundarios se modificaron.Ten en cuenta que, si modificas los datos con update(), se cancelarán las transacciones pendientes en esa ubicación, por lo que se debe tener mucho cuidado si combinas update() y transaction() para modificar los mismos datos.Si pasas null a update(), se quitarán los datos de esta ubicación.Consulta Introducción a las actualizaciones de varias ubicaciones y más. |
| function(value, ...) | |
| endAt(valor, clave) | Crea una QueryConstraint con el punto de finalización especificado.Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.El punto de finalización es inclusivo, por lo que los elementos secundarios con exactamente el valor especificado se incluirán en la consulta. El argumento de clave opcional se puede usar para limitar aún más el rango de la consulta. Si se especifica, los elementos secundarios que tengan exactamente el valor especificado también deben tener un nombre de clave menor o igual que la clave especificada.Puedes obtener más información sobre endAt() en Filtra datos. |
| endBefore(valor, clave) | Crea una QueryConstraint con el punto de finalización especificado (exclusivo).Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.El punto de finalización es exclusivo. Si solo se proporciona un valor, se incluirán en la consulta los elementos secundarios que tengan un valor inferior al especificado. Si se especifica una clave, los campos secundarios deben tener un valor menor o igual que el valor especificado y un nombre de clave menor que la clave especificada. |
| equalTo(valor, clave) | Crea un QueryConstraint que incluya elementos secundarios que coincidan con el valor especificado.Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.El argumento de clave opcional se puede usar para limitar aún más el rango de la consulta. Si se especifica, los elementos secundarios que tienen exactamente el valor especificado también deben tener exactamente la clave especificada como nombre de clave. Se puede usar para filtrar conjuntos de resultados que tengan muchas coincidencias para el mismo valor.Puedes obtener más información sobre equalTo() en Cómo filtrar datos. |
| startAfter(valor, clave) | Crea una QueryConstraint con el punto de partida especificado (exclusivo).Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.El punto de partida es exclusivo. Si solo se proporciona un valor, los elementos secundarios que tengan un valor mayor que el especificado se incluirán en la consulta. Si se especifica una clave, los elementos secundarios deben tener un valor mayor o igual que el valor especificado y un nombre de clave superior a la clave especificada. |
| startAt(valor, clave) | Crea una QueryConstraint con el punto de partida especificado.Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.El punto de partida es inclusivo, por lo que los elementos secundarios con exactamente el valor especificado se incluirán en la consulta. El argumento de clave opcional se puede usar para limitar aún más el rango de la consulta. Si se especifica, los elementos secundarios que tengan exactamente el valor especificado también deben tener un nombre de clave mayor o igual que la clave especificada.Puedes obtener más información sobre startAt() en Filtra datos. |
Clases
| Clase | Descripción |
|---|---|
| Base de datos | Clase que representa una Firebase Realtime Database. |
| Instantánea de datos | Un DataSnapshot contiene datos de una ubicación de la base de datos.Cada vez que lees datos de la base de datos, los recibes como una DataSnapshot. Se pasa un DataSnapshot a las devoluciones de llamada de eventos que adjuntas con on() o once(). Puedes extraer el contenido de la instantánea como un objeto de JavaScript llamando al método val(). Como alternativa, puedes atravesar la instantánea llamando a child() para mostrar instantáneas secundarias (en las que luego podrías llamar a val()).Un DataSnapshot es una copia inmutable y generada de manera eficiente de los datos en una ubicación de la base de datos. No se puede modificar y nunca cambiará (para modificar datos, siempre debes llamar directamente al método set() en un Reference). |
| OnDesconectar | La clase onDisconnect te permite escribir o borrar datos cuando el cliente se desconecta del servidor de la base de datos. Estas actualizaciones ocurren sin importar si tu cliente se desconecta de manera limpia o no, por lo que puedes confiar en ellas para limpiar los datos incluso si se pierde la conexión o un cliente falla.La clase onDisconnect se usa con mayor frecuencia para administrar la presencia en aplicaciones en las que es útil detectar cuántos clientes están conectados y cuándo se desconectan otros. Consulta Habilita funciones sin conexión en JavaScript para obtener más información.Para evitar problemas cuando se pierde una conexión antes de que las solicitudes se puedan transferir al servidor de la base de datos, se debe llamar a estas funciones antes de escribir datos.Ten en cuenta que las operaciones onDisconnect solo se activan una vez. Si quieres que se ejecute una operación cada vez que se produzca una desconexión, deberás restablecer las operaciones de onDisconnect cada vez que te vuelvas a conectar. |
| QueryConstraint | Se usa QueryConstraint para reducir el conjunto de documentos que muestra una consulta de base de datos. QueryConstraintQueryConstraint |
| TransactionResult (en inglés) | Un tipo para el valor de resolución de runTransaction(). |
Interfaces
| Interfaz | Descripción |
|---|---|
| Referencia de base de datos | Un DatabaseReference representa una ubicación específica de tu base de datos y se puede usar para leer o escribir datos en esa ubicación.Puedes hacer referencia a la ubicación raíz o secundaria de la 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*(). Consulta https://firebase.google.com/docs/database/web/read-and-write |
| IteratedDataSnapshot | Representa una instantánea secundaria de un objeto Reference que se está iterando. La clave nunca será indefinida. |
| ListenOptions | Un objeto de opciones que se puede usar para personalizar un objeto de escucha. |
| Consulta | Un Query ordena y filtra los datos en una ubicación de la base de datos para que solo se incluya un subconjunto de los datos secundarios. Esto se puede usar para ordenar una colección de datos por algún atributo (por ejemplo, altura de dinosaurios) y también para restringir una gran lista de elementos (por ejemplo, mensajes de chat) a un número adecuado para la sincronización con el cliente. Las consultas se crean mediante el encadenamiento de uno o más de los métodos de filtro que se definen aquí.Al igual que con un DatabaseReference, puedes recibir datos de un Query mediante los métodos on*(). Solo recibirás eventos y objetos DataSnapshot para el subconjunto de datos que coincida con tu consulta.Para obtener más información, visita https://firebase.google.com/docs/database/web/lists-of-data#sorting_and_filtering_data. |
| thenableReference | Es un Promise que también puede actuar como DatabaseReference cuando lo muestra push(). La referencia está disponible de inmediato y Promise se resuelve a medida que se completa la escritura en el backend. |
| TransactionOptions | Un objeto de opciones para configurar transacciones. |
Escribe alias
| Alias de tipo | Descripción |
|---|---|
| EventType | Una de las siguientes cadenas: "value", "child_added", "child_changed", "child_quitado" o "child_moved". |
| QueryConstraintType | Describe las diferentes restricciones de consultas disponibles en este SDK. |
| Anular la suscripción | Es una devolución de llamada que se puede invocar para quitar un objeto de escucha. |
función(app, ...)
getDatabase(app, url)
Muestra la instancia del SDK de Realtime Database asociada con la FirebaseApp proporcionada. Inicializa una instancia nueva con configuración predeterminada si no existe una 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 |
|---|---|---|
| app | App de Firebase | La instancia de FirebaseApp con la que está asociada la instancia de Realtime Database que se muestra. |
| url | string | La URL de la instancia de Realtime Database a la que deseas conectarte. Si no se proporciona, el SDK se conecta a la instancia predeterminada de la app de Firebase. |
Muestra:
La instancia de Database de la app proporcionada.
función(db, ...)
connectDatabaseEmulator(db, host, puerto, opciones)
Modifica la instancia proporcionada para que se comunique con el emulador de Realtime Database.
Nota: Se debe llamar a este método 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 |
|---|---|---|
| db | Base de datos | La instancia que se modificará. |
| host | string | El host del emulador (p. ej., localhost) |
| puerto | número | El puerto del emulador (p. ej., 8080) |
| opciones | { falsoUserToken?: EmulatorMockTokenOptions | cadena; }. |
Muestra:
void
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á activo de forma indefinida y se volverá a conectar cuando se desconecte. Sin embargo, se pueden usar los métodos goOffline() y goOnline() para controlar la conexión del cliente en los casos en los que una conexión persistente no es deseable.
Mientras esté sin conexión, el cliente ya no recibirá actualizaciones de datos de la base de datos. Sin embargo, todas las operaciones de la base de datos que se realizan de forma local seguirán activando eventos de forma inmediata, lo que permitirá que la aplicación continúe comportándose con normalidad. Además, cada operación realizada de manera local se pondrá en cola automáticamente y se volverá a intentar tras volver a conectarse al servidor de la base de datos.
Para volver a conectarte a la base de datos y comenzar a recibir eventos remotos, consulta goOnline().
Firma:
export declare function goOffline(db: Database): void;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| db | Base de datos | La instancia que se debe desconectar. |
Muestra:
void
goOnline(db)
Se vuelve a conectar al servidor y sincroniza el estado de la base de datos sin conexión con el estado del servidor.
Se debe usar este método después de inhabilitar la conexión activa con goOffline(). Una vez que se recupere la conexión, el cliente transmitirá los datos correctos y activará los eventos correspondientes para que el cliente se "ponga al día" automáticamente.
Firma:
export declare function goOnline(db: Database): void;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| db | Base de datos | La instancia que se debe volver a conectar. |
Muestra:
void
ref(db, ruta)
Muestra una Reference que representa la ubicación en la base de datos que corresponde a la ruta de acceso proporcionada. Si no se proporciona una ruta de acceso, 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 |
|---|---|---|
| db | Base de datos | La instancia de base de datos para la que se obtiene una referencia. |
| ruta | string | Es la ruta de acceso opcional que representa la ubicación a la que apuntará el Reference que se muestra. Si no se proporciona, el Reference que se muestre apuntará a la raíz de la base de datos. |
Muestra:
Si se proporciona una ruta de acceso, es un Reference que apunta a la ruta proporcionada. De lo contrario, es una Reference que apunta a la raíz de la base de datos.
refFromURL(db, url)
Muestra una Reference que representa la ubicación en la base de datos que corresponde a la URL de Firebase proporcionada.
Se arroja una excepción si la URL no es una URL válida de Firebase Database o tiene un dominio diferente al de la instancia Database actual.
Ten en cuenta que todos los parámetros de búsqueda (orderBy, limitToLast, etc.) se ignoran y no se aplican al Reference que se muestra.
Firma:
export declare function refFromURL(db: Database, url: string): DatabaseReference;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| db | Base de datos | La instancia de base de datos para la que se obtiene una referencia. |
| url | string | La URL de Firebase a la que apuntará el Reference que se muestra. |
Muestra:
Un elemento Reference que dirige a la URL de Firebase proporcionada.
función()
ForceLongPolling()
Fuerza el uso de longPolling en lugar de websockets. Se ignorará si se usa el protocolo websocket en databaseURL.
Firma:
export declare function forceLongPolling(): void;
Muestra:
void
ForceWebSockets()
Fuerza el uso de websockets en lugar de longPolling.
Firma:
export declare function forceWebSockets(): void;
Muestra:
void
orderByKey()
Crea un QueryConstraint nuevo que ordena según la clave.
Ordena los resultados de una consulta según sus valores clave (ascendentes).
Obtén más información sobre orderByKey() en Cómo ordenar datos.
Firma:
export declare function orderByKey(): QueryConstraint;
Muestra:
orderByPriority()
Crea un QueryConstraint nuevo que ordena por prioridad.
No es necesario que las aplicaciones usen la prioridad, pero pueden ordenar las colecciones por propiedades comunes (consulta Cómo ordenar datos para conocer las alternativas a la prioridad.
Firma:
export declare function orderByPriority(): QueryConstraint;
Muestra:
orderByValue()
Crea un QueryConstraint nuevo que ordena según el valor.
Si los elementos secundarios de una consulta son todos valores escalares (de cadena, número o booleano), puedes ordenar los resultados por sus valores (ascendentes).
Obtén más información sobre orderByValue() en Cómo ordenar datos.
Firma:
export declare function orderByValue(): QueryConstraint;
Muestra:
serverTimestamp()
Devuelve un valor de marcador de posición para propagar automáticamente la marca de tiempo actual (tiempo desde el tiempo Unix, en milisegundos) según lo determinan los servidores de Firebase.
Firma:
export declare function serverTimestamp(): object;
Muestra:
objeto
función(delta, ...)
incremento(delta)
Muestra un valor de marcador de posición que se puede usar para aumentar de forma atómica el valor actual de la base de datos 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 de forma atómica. |
Muestra:
objeto
Un valor de marcador de posición para modificar datos de forma atómica del servidor.
función(habilitada, ...)
enableLogging(habilitado, persistente)
Registra la 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 |
|---|---|---|
| habilitado | booleano | Habilita el registro si es true y lo inhabilita si es false. |
| persistentes | booleano | Recuerda el estado de registro entre las actualizaciones de página si es true. |
Muestra:
cualquiera
función(límite, ...)
limitToFirst(límite)
Crea un QueryConstraint nuevo que, si se limita a la primera cantidad específica de elementos secundarios.
El método limitToFirst() se usa para establecer una cantidad máxima de elementos secundarios que se sincronizarán para una devolución de llamada determinada. Si establecemos un límite de 100, inicialmente solo obtendremos un máximo de 100 eventos de child_added. Si tenemos menos de 100 mensajes almacenados en nuestra base de datos, se activará un evento child_added por cada uno de ellos. Sin embargo, si tenemos más de 100 mensajes, solo recibiremos un evento child_added para los primeros 100 mensajes ordenados. A medida que cambien los elementos, recibiremos eventos de child_removed por cada elemento que quede fuera de la lista activa, de modo que la cantidad total siga siendo 100.
Puedes obtener más información sobre limitToFirst() en Cómo filtrar datos.
Firma:
export declare function limitToFirst(limit: number): QueryConstraint;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| límite | número | La cantidad máxima de nodos que se deben incluir en esta consulta. |
Muestra:
limitToLast(límite)
Crea un QueryConstraint nuevo que se limita a mostrar solo la última cantidad especificada de elementos secundarios.
El método limitToLast() se usa para establecer una cantidad máxima de elementos secundarios que se sincronizarán para una devolución de llamada determinada. Si establecemos un límite de 100, inicialmente solo obtendremos un máximo de 100 eventos de child_added. Si tenemos menos de 100 mensajes almacenados en nuestra base de datos, se activará un evento child_added por cada uno de ellos. Sin embargo, si tenemos más de 100 mensajes, solo recibiremos un evento child_added para los últimos 100 mensajes ordenados. A medida que cambien los elementos, recibiremos eventos de child_removed por cada elemento que quede fuera de la lista activa, de modo que la cantidad total siga siendo 100.
Puedes obtener más información sobre limitToLast() en Cómo filtrar datos.
Firma:
export declare function limitToLast(limit: number): QueryConstraint;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| límite | número | La cantidad máxima de nodos que se deben incluir en esta consulta. |
Muestra:
función(registrador, ...)
enableLogging(registrador)
Registra la 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 |
|---|---|---|
| logger | (mensaje: cadena) => Desconocida | Una función de registrador personalizada para controlar cómo se registran los datos. |
Muestra:
cualquiera
función(principal, ...)
secundario(principal, ruta de acceso)
Obtiene un objeto Reference para la ubicación en la ruta de acceso relativa especificada.
La ruta de acceso relativa puede ser un nombre secundario simple (por ejemplo, “ada”) o una ruta de acceso separada por barras más profundas (por ejemplo, “ada/nombre/primero”).
Firma:
export declare function child(parent: DatabaseReference, path: string): DatabaseReference;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| elemento superior | Referencia de base de datos | La ubicación principal. |
| ruta | string | Una ruta de acceso relativa desde esta ubicación hasta la ubicación secundaria deseada. |
Muestra:
Es la ubicación secundaria especificada.
push(elemento superior, valor)
Genera una ubicación secundaria nueva con una clave única y muestra su Reference.
Este es el patrón más común para agregar datos a una colección de elementos.
Si proporcionas un valor a push(), el valor se escribe en la ubicación generada. Si no pasas un valor, no se escribe nada en la base de datos y el elemento secundario permanece vacío (pero puedes usar Reference en otro lugar).
Las claves únicas que genera push() se ordenan según la hora actual, por lo que la lista de elementos resultante se ordena cronológicamente. Las claves también están diseñadas para ser indescifrables (contienen 72 bits de entropía aleatorios).
Consulta Agrega datos a una lista de datos. Consulta 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 |
|---|---|---|
| elemento superior | Referencia de base de datos | La ubicación principal. |
| valor | desconocido | Valor opcional que se escribirá en la ubicación generada. |
Muestra:
Combinación de Promise y Reference se resuelve cuando se completa la escritura, pero se puede usar de inmediato como Reference en la ubicación secundaria.
función(ruta, ...)
orderByChild(ruta)
Crea un elemento QueryConstraint nuevo que ordena según la clave secundaria especificada.
Las consultas solo pueden ordenarse por una clave a la vez. Si llamas a orderByChild() varias veces en la misma consulta, se produce un error.
Las consultas de Firebase te permiten ordenar tus datos según cualquier clave secundaria sobre la marcha. Sin embargo, si sabes de antemano cuáles serán tus índices, puedes definirlos a través de la regla .indexOn en tus reglas de seguridad para obtener un mejor rendimiento. Para obtener más información, consulta la regla https://firebase.google.com/docs/database/security/indexing-data.
Obtén más información sobre orderByChild() en Cómo ordenar datos.
Firma:
export declare function orderByChild(path: string): QueryConstraint;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ruta | string | La ruta de acceso para ordenar. |
Muestra:
función(consulta, ...)
get(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 que se ejecutará. |
Muestra:
Promesa<DataSnapshot>
Una Promise que se resuelve en la DataSnapshot resultante si hay un valor disponible o se rechaza si el cliente no puede mostrar un valor (p.ej., si no se puede acceder al servidor y no hay nada almacenado en caché).
off(consulta, tipo de evento, devolución de llamada)
Desconecta una devolución de llamada que se adjuntó anteriormente con el objeto de escucha on*() correspondiente (onValue, onChildAdded). Nota: Esta no es la forma recomendada de quitar un objeto de escucha. En su lugar, usa la función de devolución de llamada que se muestra desde las devoluciones de llamada on* respectivas.
Desconecta una devolución de llamada que se adjuntó anteriormente con on*(). Si llamas a off() en un objeto de escucha superior, no se quitarán automáticamente los objetos de escucha registrados en los nodos secundarios. Deberás llamar a off() también en todos los objetos de escucha secundarios para quitar la devolución de llamada.
Si no se especifica una devolución de llamada, se quitarán todas las devoluciones de llamada para el eventType especificado. Del mismo modo, si no se especifica eventType, se quitarán todas las devoluciones de llamada para Reference.
Los objetos de escucha individuales también se pueden quitar invocando sus devoluciones de llamada para anular 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 objeto de escucha. |
| eventType | EventType | Una de las siguientes cadenas: "value", "child_added", "child_changed", "child_quitado" o "child_moved". Si se omite, se quitarán todas las devoluciones de llamada para Reference. |
| callback | (instantánea: DataSnapshot, previousChildName?: string | null) => Desconocida | La función de devolución de llamada que se pasó a on() o undefined para quitar todas las devoluciones de llamada |
Muestra:
void
onChildAdded(consulta, devolución de llamada, cancelCallback)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildAdded una vez por cada elemento secundario inicial en esta ubicación y se volverá a activar cada vez que se agregue un nuevo elemento secundario. La DataSnapshot que se pase a la devolución de llamada reflejará los datos del elemento secundario relevante. Para ordenar, se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName?: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildAdded(consulta, devolución de llamada, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildAdded una vez por cada elemento secundario inicial en esta ubicación y se volverá a activar cada vez que se agregue un nuevo elemento secundario. La DataSnapshot que se pase a la devolución de llamada reflejará los datos del elemento secundario relevante. Para ordenar, se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildAdded(consulta, devolución de llamada, cancelCallback, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildAdded una vez por cada elemento secundario inicial en esta ubicación y se volverá a activar cada vez que se agregue un nuevo elemento secundario. La DataSnapshot que se pase a la devolución de llamada reflejará los datos del elemento secundario relevante. Para ordenar, se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildChanged(consulta, devolución de llamada, cancelCallback)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildChanged cuando cambien los datos almacenados en un elemento secundario (o cualquiera de sus elementos subordinados). Ten en cuenta que un solo evento child_changed puede representar varios cambios en el elemento secundario. La DataSnapshot pasada a la devolución de llamada contendrá el nuevo contenido secundario. Para ordenar, la devolución de llamada también recibe un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildChanged(consulta, devolución de llamada, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildChanged cuando cambien los datos almacenados en un elemento secundario (o cualquiera de sus elementos subordinados). Ten en cuenta que un solo evento child_changed puede representar varios cambios en el elemento secundario. La DataSnapshot pasada a la devolución de llamada contendrá el nuevo contenido secundario. Para ordenar, la devolución de llamada también recibe un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildChanged(consulta, devolución de llamada, cancelCallback, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildChanged cuando cambien los datos almacenados en un elemento secundario (o cualquiera de sus elementos subordinados). Ten en cuenta que un solo evento child_changed puede representar varios cambios en el elemento secundario. La DataSnapshot pasada a la devolución de llamada contendrá el nuevo contenido secundario. Para ordenar, la devolución de llamada también recibe un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildMove(consulta, devolución de llamada, cancelCallback)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildMoved cuando cambie el orden de clasificación de un elemento secundario, de modo que cambie su posición en relación con los elementos del mismo nivel. El DataSnapshot pasado a la devolución de llamada será para los datos del elemento secundario que se movió. También se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildMove(consulta, devolución de llamada, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildMoved cuando cambie el orden de clasificación de un elemento secundario, de modo que cambie su posición en relación con los elementos del mismo nivel. El DataSnapshot pasado a la devolución de llamada será para los datos del elemento secundario que se movió. También se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildMove(consulta, devolución de llamada, cancelCallback, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildMoved cuando cambie el orden de clasificación de un elemento secundario, de modo que cambie su posición en relación con los elementos del mismo nivel. El DataSnapshot pasado a la devolución de llamada será para los datos del elemento secundario que se movió. También se le pasa un segundo argumento, que es una cadena que contiene la clave del elemento secundario del mismo nivel anterior por orden de clasificación, o null si es el primer elemento secundario.
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 que se ejecutará. |
| callback | (instantánea: DataSnapshot, previousChildName: string | null) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildRemoved(consulta, devolución de llamada, cancelCallback)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildRemoved cada vez que se quite un elemento secundario. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del elemento secundario que se quitó. Se quitará a tu hijo o hija en los siguientes casos:
- un cliente llama explícitamente a
remove()en ese elemento secundario o en uno de sus elementos principales, un cliente llama aset(null)en ese elemento secundario o en uno de sus elementos principales, y se quitaron todos los elementos secundarios de ese elemento secundario; hay una consulta vigente que ahora filtra el elemento secundario (porque cambió su 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 que se ejecutará. |
| callback | (instantánea: DataSnapshot) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildRemoved(consulta, devolución de llamada, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildRemoved cada vez que se quite un elemento secundario. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del elemento secundario que se quitó. Se quitará a tu hijo o hija en los siguientes casos:
- un cliente llama explícitamente a
remove()en ese elemento secundario o en uno de sus elementos principales, un cliente llama aset(null)en ese elemento secundario o en uno de sus elementos principales, y se quitaron todos los elementos secundarios de ese elemento secundario; hay una consulta vigente que ahora filtra el elemento secundario (porque cambió su 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 que se ejecutará. |
| callback | (instantánea: DataSnapshot) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onChildRemoved(consulta, devolución de llamada, cancelCallback, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onChildRemoved cada vez que se quite un elemento secundario. El DataSnapshot pasado a la devolución de llamada serán los datos antiguos del elemento secundario que se quitó. Se quitará a tu hijo o hija en los siguientes casos:
- un cliente llama explícitamente a
remove()en ese elemento secundario o en uno de sus elementos principales, un cliente llama aset(null)en ese elemento secundario o en uno de sus elementos principales, y se quitaron todos los elementos secundarios de ese elemento secundario; hay una consulta vigente que ahora filtra el elemento secundario (porque cambió su 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 que se ejecutará. |
| callback | (instantánea: DataSnapshot) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot y una string que contiene la clave del elemento secundario anterior, por orden de clasificación, o null si es el primer elemento secundario. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onValue(consulta, devolución de llamada, cancelCallback)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onValue una vez con los datos iniciales almacenados en esta ubicación y, luego, se activará de nuevo cada vez que cambien los datos. El DataSnapshot que se pasa a la devolución de llamada será para la ubicación en la que se llamó a on(). No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con un elemento DataSnapshot vacío (val() mostrará 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 que se ejecutará. |
| callback | (instantánea: DataSnapshot) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onValue(consulta, devolución de llamada, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onValue una vez con los datos iniciales almacenados en esta ubicación y, luego, se activará de nuevo cada vez que cambien los datos. El DataSnapshot que se pasa a la devolución de llamada será para la ubicación en la que se llamó a on(). No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con un elemento DataSnapshot vacío (val() mostrará 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 que se ejecutará. |
| callback | (instantánea: DataSnapshot) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
onValue(consulta, devolución de llamada, cancelCallback, opciones)
Detecta cambios en los datos en una ubicación particular.
Esta es la forma principal de leer datos de una base de datos. Se activará la devolución de llamada para los datos iniciales y otra vez cuando los datos cambien. Invoca la devolución de llamada para anular la suscripción que se muestra si quieres dejar de recibir actualizaciones. Consulta Recupera datos en la Web para obtener más detalles.
Se activará un evento onValue una vez con los datos iniciales almacenados en esta ubicación y, luego, se activará de nuevo cada vez que cambien los datos. El DataSnapshot que se pasa a la devolución de llamada será para la ubicación en la que se llamó a on(). No se activará hasta que se haya sincronizado todo el contenido. Si la ubicación no tiene datos, se activará con un elemento DataSnapshot vacío (val() mostrará 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 que se ejecutará. |
| callback | (instantánea: DataSnapshot) => Desconocida | Una devolución de llamada que se activa cuando ocurre el evento especificado. La devolución de llamada recibirá una DataSnapshot. |
| cancelCallback | (error: Error) => Desconocida | Es una devolución de llamada opcional que se notificará si alguna vez se cancela la suscripción al evento porque tu cliente no tiene permiso para leer estos datos (o tenía permiso, pero ahora los perdió). Se pasará a esta devolución de llamada un objeto Error que indica el motivo del error. |
| opciones | ListenOptions | Un objeto que se puede usar para configurar onlyOnce, que luego quita el objeto de escucha después de su primera invocación. |
Muestra:
Una función que se puede invocar para quitar el objeto de escucha.
query(query, queryConstraints)
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 consulta que se usará como base para las restricciones nuevas. |
| queryConstraints | QueryConstraint[] | Es la lista de QueryConstraint que se aplicarán. |
Muestra:
Excepciones
si alguna de las restricciones de consulta proporcionadas no se puede combinar con las restricciones existentes o nuevas.
función(ref, ...)
onDesconectar(ref)
Muestra un objeto OnDisconnect. Consulta Cómo habilitar funciones 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 |
|---|---|---|
| ref | Referencia de base de datos | La referencia para la que se deben agregar activadores OnDisconnect. |
Muestra:
quitar(ref)
Quita los datos de esta ubicación de la base de datos.
También se borrarán los datos de las ubicaciones secundarias.
El efecto de la eliminación será visible de inmediato y el valor del evento correspondiente se activará. También se iniciará la sincronización de la eliminación con los servidores de Firebase y la promesa que se muestra se resolverá cuando se complete. Si se proporciona, se llamará a la devolución de llamada onComplete de forma asíncrona después de que finalice la sincronización.
Firma:
export declare function remove(ref: DatabaseReference): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ref | Referencia de base de datos | La ubicación que se quitará. |
Muestra:
Promesa<void>
Se resuelve cuando se completa la acción de quitar del servidor.
runTransaction(ref, transactionUpdate, opciones)
Modifica los datos de esta ubicación de forma atómica.
Modificar los datos de esta ubicación de forma atómica. A diferencia de una set() normal, que solo reemplaza los datos independientemente de su valor anterior, runTransaction() se usa para modificar el valor existente por un valor nuevo, lo que garantiza que no haya conflictos con otros clientes que escriben en la misma ubicación al mismo tiempo.
Para lograrlo, pasa una función de actualización a runTransaction() que se usa para transformar el valor actual en un valor nuevo. Si otro cliente escribe en la ubicación antes de que el nuevo valor se escriba correctamente, se volverá a llamar a la función de actualización con el nuevo valor actual y se volverá a intentar la escritura. Esto sucederá de manera repetida hasta que la escritura se realice de forma correcta sin que se genere ningún conflicto o hasta que anules la transacción si no devuelves un valor de la 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 |
|---|---|---|
| ref | Referencia de base de datos | La ubicación que se modificará de forma atómica. |
| transactionUpdate | (currentData: cualquiera) => Desconocida | Una función proporcionada por el desarrollador a la que se le enviarán los datos actuales almacenados en esta ubicación (como un objeto de JavaScript). La función debería mostrar el valor nuevo que quiere escribir (como un objeto de JavaScript). Si se devuelve undefined (es decir, muestras sin argumentos), se anulará la transacción y no se modificarán los datos de esta ubicación. |
| opciones | TransactionOptions | Un objeto de opciones para configurar transacciones. |
Muestra:
Promesa<TransactionResult>
Un Promise que se puede usar de manera opcional en lugar de la devolución de llamada onComplete para controlar el éxito y el fracaso.
set(ref, valor)
Escribe datos en esta ubicación de la base de datos.
Esta acción reemplazará todos los datos de esta ubicación y de todas las ubicaciones secundarias.
El efecto de la escritura será visible de inmediato y se activarán los eventos correspondientes (“value”, “child_added”, etc.). También se iniciará la sincronización de los datos con los servidores de Firebase y la promesa que se muestra se resolverá cuando se complete. Si se proporciona, se llamará a la devolución de llamada onComplete de forma asíncrona después de que finalice la sincronización.
Pasar null para el valor nuevo equivale a llamar a remove(). es decir, se borrarán todos los datos de esta ubicación y todas las ubicaciones secundarias.
set() quitará cualquier prioridad almacenada en esta ubicación, por lo que, si la prioridad debe conservarse, debes usar setWithPriority() en su lugar.
Ten en cuenta que, si modificas los datos con set(), se cancelarán todas las transacciones pendientes en esa ubicación, por lo que se debe tener mucho cuidado si combinas set() y transaction() para modificar los mismos datos.
Un solo set() generará un solo "valor" en la ubicación donde se realizó la set().
Firma:
export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ref | Referencia de base de datos | La ubicación en la que se escribirá. |
| valor | desconocido | Valor que se va a escribir (cadena, número, valor booleano, objeto, matriz o nulo) |
Muestra:
Promesa<void>
Se resuelve cuando se completa la escritura en el servidor.
setPriority(ref, prioridad)
Establece una prioridad para los datos en esta ubicación de la base de datos.
No es necesario que las aplicaciones usen la prioridad, pero pueden ordenar las colecciones por propiedades comunes (consulta Ordenar y filtrar datos).
Firma:
export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ref | Referencia de base de datos | La ubicación en la que se escribirá. |
| priority | cadena | número | nulo | La prioridad que se escribirá (cadena, número o nulo). |
Muestra:
Promesa<void>
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. Es similar a set(), pero también especifica la prioridad de esos datos.
No es necesario que las aplicaciones usen la prioridad, pero pueden ordenar las colecciones por propiedades comunes (consulta 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 |
|---|---|---|
| ref | Referencia de base de datos | La ubicación en la que se escribirá. |
| valor | desconocido | Valor que se va a escribir (cadena, número, valor booleano, objeto, matriz o nulo) |
| priority | cadena | número | nulo | La prioridad que se escribirá (cadena, número o nulo). |
Muestra:
Promesa<void>
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 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 de acceso relativa (por ejemplo, "nombre/primera") desde la ubicación actual hasta los datos que se actualizarán.
A diferencia del método set(), se puede usar update() para actualizar de forma selectiva 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 de inmediato y se activarán los eventos correspondientes ("value", "child_added", etc.). También se iniciará la sincronización de los datos con los servidores de Firebase y la promesa que se muestra se resolverá cuando se complete. Si se proporciona, se llamará a la devolución de llamada onComplete de forma asíncrona después de que finalice la sincronización.
Un solo update() generará un solo "valor" en la ubicación donde se realizó la update(), sin importar la cantidad de elementos secundarios que se modificaron.
Ten en cuenta que, si modificas los datos con update(), se cancelarán todas las transacciones pendientes en esa ubicación, por lo que se debe tener mucho cuidado si combinas update() y transaction() para modificar los mismos datos.
Si pasas null a update(), se quitarán los datos de esta ubicación.
Consulta Introducción a las actualizaciones de varias ubicaciones y mucho más.
Firma:
export declare function update(ref: DatabaseReference, values: object): Promise<void>;
Parámetros
| Parámetro | Tipo | Descripción |
|---|---|---|
| ref | Referencia de base de datos | La ubicación en la que se escribirá. |
| valores | objeto | Objeto que contiene varios valores |
Muestra:
Promesa<void>
Se resuelve cuando se completa la actualización en el servidor.
función(valor, ...)
endAt(valor, clave)
Crea un QueryConstraint con el punto de finalización especificado.
Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.
El punto de finalización es inclusivo, por lo que los elementos secundarios con exactamente el valor especificado se incluirán en la consulta. El argumento de clave opcional se puede usar para limitar aún más el rango de la consulta. Si se especifica, los elementos secundarios que tienen exactamente el valor especificado también deben tener un nombre de clave menor o igual que la clave especificada.
Puedes obtener más información sobre endAt() en Cómo filtrar 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 | Valor con el que se debe terminar. El tipo de argumento depende de la función orderBy() que se usó en esta consulta. Especifica un valor que coincida con el tipo orderBy(). Cuando se usa en combinación con orderByKey(), el valor debe ser una cadena. |
| clave | string | La clave secundaria en la que se debe terminar, entre los elementos secundarios con la prioridad especificada anteriormente. Este argumento solo se permite si se ordena por elemento secundario, valor o prioridad. |
Muestra:
endBefore(valor, clave)
Crea un QueryConstraint con el punto de finalización especificado (exclusivo).
Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.
El destino es exclusivo. Si solo se proporciona un valor, se incluirán en la consulta los elementos secundarios que tengan un valor inferior al especificado. Si se especifica una clave, los campos secundarios deben tener un valor menor o igual que el 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 | Valor que se debe terminar antes. El tipo de argumento depende de la función orderBy() que se usó en esta consulta. Especifica un valor que coincida con el tipo orderBy(). Cuando se usa en combinación con orderByKey(), el valor debe ser una cadena. |
| clave | string | La clave secundaria que se debe finalizar antes, entre los elementos secundarios con la prioridad especificada anteriormente. Este argumento solo se permite si se ordena por elemento secundario, valor o prioridad. |
Muestra:
igualA(valor, clave)
Crea un QueryConstraint que incluye elementos secundarios que coinciden con el valor especificado.
Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.
El argumento de clave opcional se puede usar para limitar aún más el rango de la consulta. Si se especifica, los elementos secundarios que tienen exactamente el valor especificado también deben tener exactamente la clave especificada como nombre de clave. Se puede usar para filtrar conjuntos de resultados con muchas coincidencias para el mismo valor.
Puedes obtener más información sobre equalTo() en Cómo filtrar 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 | Valor con el que se debe buscar. El tipo de argumento depende de la función orderBy() que se usó en esta consulta. Especifica un valor que coincida con el tipo orderBy(). Cuando se usa en combinación con orderByKey(), el valor debe ser una cadena. |
| clave | string | La clave secundaria en la que se va a comenzar, entre los elementos secundarios con la prioridad especificada anteriormente. Este argumento solo se permite si se ordena por elemento secundario, valor o prioridad. |
Muestra:
startAfter(valor, clave)
Crea un QueryConstraint con el punto de partida especificado (exclusivo).
Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.
El punto de partida es exclusivo. Si solo se proporciona un valor, los elementos secundarios que tengan un valor mayor que el especificado se incluirán en la consulta. Si se especifica una clave, los elementos secundarios deben tener un valor mayor o igual que el valor especificado y un nombre de clave superior a 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 | Valor con el que se va a empezar. El tipo de argumento depende de la función orderBy() que se usó en esta consulta. Especifica un valor que coincida con el tipo orderBy(). Cuando se usa en combinación con orderByKey(), el valor debe ser una cadena. |
| clave | string | La clave secundaria que se debe comenzar después. Este argumento solo se permite si se ordena por elemento secundario, valor o prioridad. |
Muestra:
startAt(valor, clave)
Crea un objeto QueryConstraint con el punto de partida especificado.
Si usas startAt(), startAfter(), endBefore(), endAt() y equalTo(), podrás elegir puntos arbitrarios de inicio y finalización para tus consultas.
El punto de partida es inclusivo, por lo que los elementos secundarios con exactamente el valor especificado se incluirán en la consulta. El argumento de clave opcional se puede usar para limitar aún más el rango de la consulta. Si se especifica, los elementos secundarios que tienen exactamente el valor especificado también deben tener un nombre de clave mayor o igual que la clave especificada.
Puedes obtener más información sobre startAt() en Cómo filtrar 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 | Valor con el que se empieza. El tipo de argumento depende de la función orderBy() que se usó en esta consulta. Especifica un valor que coincida con el tipo orderBy(). Cuando se usa en combinación con orderByKey(), el valor debe ser una cadena. |
| clave | string | La clave secundaria en la que se va a comenzar. Este argumento solo se permite si se ordena por elemento secundario, valor o prioridad. |
Muestra:
EventType
Una de las siguientes cadenas: "value", "child_added", "child_changed", "child_quitado" o "child_moved".
Firma:
export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
Tipo de restricción de consultas
Describe las diferentes restricciones de consultas disponibles en este SDK.
Firma:
export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';
Anular la suscripción
Es una devolución de llamada que se puede invocar para quitar un objeto de escucha.
Firma:
export declare type Unsubscribe = () => void;