database package

Base de datos en tiempo real de Firebase

Funciones

Clases

Interfaces

Tipo de alias

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

obtenerBase de datos (aplicación, URL)

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

Firma:

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

Parámetros

Devoluciones:

Base de datos

La instancia Database de la aplicación proporcionada.

función(db,...)

connectDatabaseEmulator(db, host, puerto, opciones)

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

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

Firma:

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

Parámetros

Devoluciones:

vacío

ir sin conexión (db)

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

vacío

ir en línea (db)

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

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

Firma:

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

Parámetros

Devoluciones:

vacío

ref(base de datos, ruta)

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

Firma:

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

Parámetros

Devoluciones:

Referencia de base de datos

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

referenciaDeURL(db,url)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Referencia de base de datos

Una Reference que apunta a la URL de Firebase proporcionada.

función()

fuerzaLongPolling()

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

Firma:

export declare function forceLongPolling(): void;

Devoluciones:

vacío

fuerzaWebSockets()

Fuerce el uso de websockets en lugar de longPolling.

Firma:

export declare function forceWebSockets(): void;

Devoluciones:

vacío

ordenPorClave()

Crea una nueva QueryConstraint que ordena por clave.

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

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

Firma:

export declare function orderByKey(): QueryConstraint;

Devoluciones:

Restricción de consulta

ordenPorPrioridad()

Crea una nueva QueryConstraint que ordena por prioridad.

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

Firma:

export declare function orderByPriority(): QueryConstraint;

Devoluciones:

Restricción de consulta

ordenPorValor()

Crea una nueva QueryConstraint que ordena por valor.

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

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

Firma:

export declare function orderByValue(): QueryConstraint;

Devoluciones:

Restricción de consulta

marca de tiempo del servidor()

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

Firma:

export declare function serverTimestamp(): object;

Devoluciones:

objeto

función(delta,...)

incremento(delta)

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

Firma:

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

Parámetros

Devoluciones:

objeto

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

función (habilitada, ...)

enableLogging(habilitado, persistente)

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

Firma:

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

Parámetros

Devoluciones:

cualquier

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

límiteAPrimero(límite)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Restricción de consulta

límite al último (límite)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Restricción de consulta

función(registrador, ...)

enableLogging(registrador)

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

Firma:

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

Parámetros

Devoluciones:

cualquier

función (padre, ...)

hijo (padre, ruta)

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

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

Firma:

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

Parámetros

Devoluciones:

Referencia de base de datos

La ubicación secundaria especificada.

empujar (padre, valor)

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

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Referencia entoncesable

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

función (ruta, ...)

ordenPorNiño(ruta)

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Restricción de consulta

función (consulta, ...)

obtener (consulta)

Obtiene el resultado más actualizado para esta consulta.

Firma:

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

Parámetros

Devoluciones:

Promesa< Instantánea de datos >

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

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

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

vacío

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

Escucha cambios de datos en una ubicación particular.

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

consulta (consulta, consultaRestricciones)

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

Firma:

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

Parámetros

Devoluciones:

Consulta

Excepciones

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

función(referencia, ...)

al desconectar (ref)

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

Firma:

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

Parámetros

Devoluciones:

Al desconectar

eliminar (referencia)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa < Resultado de la transacción >

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

establecer (ref, valor)

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

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

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

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la escritura en el servidor.

establecerPrioridad(ref, prioridad)

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la escritura en el servidor.

setWithPriority(ref, valor, prioridad)

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

Se resuelve cuando se completa la escritura en el servidor.

actualizar (ref, valores)

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

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

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

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

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

función(valor,...)

endAt(valor, clave)

Crea una QueryConstraint con el punto final especificado.

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

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

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

Firma:

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

Parámetros

Devoluciones:

Restricción de consulta

endBefore(valor, clave)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Restricción de consulta

igual a (valor, clave)

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Restricción de consulta

startAfter(valor, clave)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Restricción de consulta

inicioEn(valor, clave)

Crea una QueryConstraint con el punto de partida especificado.

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

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

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

Firma:

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

Parámetros

Devoluciones:

Restricción de consulta

Tipo de evento

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

Firma:

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

Tipo de restricción de consulta

Describe las diferentes restricciones de consulta disponibles en este SDK.

Firma:

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

Darse de baja

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

Firma:

export declare type Unsubscribe = () => void;