@firebase/firestore

Funciones

Clases

Interfaces

variables

Tipo de alias

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

getFirestore (aplicación)

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

Firma:

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

Parámetros

Devoluciones:

Tienda de fuego

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

getFirestore (aplicación, base de datos)

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

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

Firma:

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

Parámetros

Devoluciones:

Tienda de fuego

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

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

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

Firma:

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

Parámetros

Devoluciones:

Tienda de fuego

Una instancia de Firestore recientemente inicializada.

función (Firestore, ...)

ClearIndexedDBpersistence (Firestore)

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

Colección (Firestore, Path, PathSegments)

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

Firma:

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

Parámetros

Devoluciones:

ColecciónReferencia < DocumentData , DocumentData >

La instancia CollectionReference .

Excepciones

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

CollectionGroup (Firestore, CollectionID)

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

Firma:

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

Parámetros

Devoluciones:

Consulta < DocumentData , DocumentData >

La Query creada .

ConnectFirestoreemulator (Firestore, Host, Port, Opciones)

Modifique esta instancia para comunicarse con el emulador Cloud Firestore.

Firma:

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

Parámetros

Devoluciones:

vacío

discaplenetwork (Firestore)

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

Doc (Firestore, Path, PathSegments)

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

Firma:

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

Parámetros

Devoluciones:

Referencia de documento < DocumentData , DocumentData >

La instancia DocumentReference .

Excepciones

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

habilitarindexeddbpersistence (Firestore, Persistencesettings)

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

Intentos de habilitar el almacenamiento persistente, si es posible.

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

EnableMultitabIndexedDBpersistence (Firestore)

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

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

Enablenetwork (Firestore)

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

getPersistentCacheIndexManager (Firestore)

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

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

Firma:

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

Parámetros

Devoluciones:

PersistentCacheIndexManager | nulo

LoadBundle (Firestore, Bundledata)

Carga un paquete de Firestore en el caché local.

Firma:

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

Parámetros

Devoluciones:

Tarea de paquete de carga

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

NamedQuery (Firestore, nombre)

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

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

Firma:

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

Parámetros

Devoluciones:

Promise < Query | nulo>

Una Promise que se resuelve con la consulta o null .

OnsnapshotsinSync (Firestore, Observer)

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

OnsnapshotsinSync (Firestore, Onsync)

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

Runtransaction (Firestore, UpdateFunction, Opciones)

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa <T>

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

SetIndexConfiguration (Firestore, Configuración)

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

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

Excepciones

FirestoreError si el formato JSON no es válido.

SetIndexConfiguration (Firestore, JSON)

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

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

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

Excepciones

FirestoreError si el formato JSON no es válido.

Terminar (Firestore)

Termina la instancia de Firestore proporcionada.

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

WaitForPendingWrites (Firestore)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

WriteBatch (Firestore)

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

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

Firma:

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

Parámetros

Devoluciones:

escribir lote

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

función()

contar()

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

Firma:

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

Devoluciones:

Campo agregado <número>

Deletefield ()

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

Firma:

export declare function deleteField(): FieldValue;

Devoluciones:

Valor de campo

documentId ()

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

Firma:

export declare function documentId(): FieldPath;

Devoluciones:

Ruta de campo

getFirestore ()

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

Firma:

export declare function getFirestore(): Firestore;

Devoluciones:

Tienda de fuego

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

MemoryEagerGageCollector ()

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

Firma:

export declare function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;

Devoluciones:

MemoryEagerGageCollector

PersistentMultIlPletabManager ()

Crea una instancia de PersistentMultipleTabManager .

Firma:

export declare function persistentMultipleTabManager(): PersistentMultipleTabManager;

Devoluciones:

PersistentMultIPletAbmanager

SerververImestamp ()

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

Firma:

export declare function serverTimestamp(): FieldValue;

Devoluciones:

Valor de campo

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

GetFirestore (DatabaseId)

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

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

Firma:

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

Parámetros

Devoluciones:

Tienda de fuego

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

función (elementos, ...)

Arrayremove (elementos)

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

Firma:

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

Parámetros

Devoluciones:

Valor de campo

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

Arrayunion (elementos)

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

Firma:

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

Parámetros

Devoluciones:

Valor de campo

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

función (campo, ...)

promedio (campo)

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

Firma:

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

Parámetros

Devoluciones:

Campo agregado <Número | nulo>

suma (campo)

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

Firma:

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

Parámetros

Devoluciones:

Campo agregado <número>

función (FieldPath, ...)

Orderby (FieldPath, DirectionsTR)

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

Firma:

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

Parámetros

Devoluciones:

QueryOrderByConstraint

La consulta creada .

Dónde (FieldPath, Opstr, Value)

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

Firma:

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

Parámetros

Devoluciones:

QueryFieldFilterConstraint

La consulta creada .

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

Endat (Values ​​de campo)

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

Firma:

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

Parámetros

Devoluciones:

Consulta

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

Endbefore (Values ​​de campo)

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

Firma:

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

Parámetros

Devoluciones:

Consulta

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

startafter (Values ​​de campo)

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

Firma:

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

Parámetros

Devoluciones:

Consulta

Una consulta de query()

Startat (Values ​​de campo)

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

Firma:

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

Parámetros

Devoluciones:

Consulta

Una consulta de query() .

función (indexManager, ...)

DeleteAllPersistentCacheIndexes (indexManager)

Elimina todos los índices de caché persistentes.

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

Firma:

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

Parámetros

Devoluciones:

vacío

DesactivePersistentCacheIndexautocreation (indexManager)

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

Firma:

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

Parámetros

Devoluciones:

vacío

HabilitarPersistentCacheIndexautocreation (indexManager)

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

Esta función esta desactivada por defecto.

Firma:

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

Parámetros

Devoluciones:

vacío

función (izquierda, ...)

AgregateFieldEqual (izquierda, derecha)

Compara dos 'Aggregatefield `Instancias de igualdad.

Firma:

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

Parámetros

Devoluciones:

booleano

aggregateQuerySnapshotEqual(left, right)

Compares two AggregateQuerySnapshot instances for equality.

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

Firma:

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

Parámetros

Devoluciones:

booleano

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

queryEqual(left, right)

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

Firma:

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

Parámetros

Devoluciones:

booleano

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

refEqual(left, right)

Returns true if the provided references are equal.

Firma:

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

Parámetros

Devoluciones:

booleano

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

snapshotEqual(left, right)

Returns true if the provided snapshots are equal.

Firma:

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

Parámetros

Devoluciones:

booleano

true if the snapshots are equal.

function(limit, ...)

limit(limit)

Creates a QueryLimitConstraint that only returns the first matching documents.

Firma:

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

Parámetros

Devoluciones:

QueryLimitConstraint

The created QueryLimitConstraint .

limitToLast(limit)

Creates a QueryLimitConstraint that only returns the last matching documents.

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

Firma:

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

Parámetros

Devoluciones:

QueryLimitConstraint

The created QueryLimitConstraint .

function(logLevel, ...)

setLogLevel(logLevel)

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

Firma:

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

Parámetros

Devoluciones:

vacío

function(n, ...)

increment(n)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Valor de campo

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

function(query, ...)

getAggregateFromServer(query, aggregateSpec)

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

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

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

Firma:

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

Parámetros

Devoluciones:

Promise< AggregateQuerySnapshot <AggregateSpecType, AppModelType, DbModelType>>

Ejemplo

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

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

getCountFromServer(query)

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

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

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

Firma:

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

Parámetros

Devoluciones:

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

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

getDocs(query)

Executes the query and returns the results as a QuerySnapshot .

Firma:

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

Parámetros

Devoluciones:

Promise< QuerySnapshot <AppModelType, DbModelType>>

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

getDocsFromCache(query)

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

Firma:

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

Parámetros

Devoluciones:

Promise< QuerySnapshot <AppModelType, DbModelType>>

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

getDocsFromServer(query)

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

Firma:

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

Parámetros

Devoluciones:

Promise< QuerySnapshot <AppModelType, DbModelType>>

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

onSnapshot(query, observer)

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

onSnapshot(query, options, observer)

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

onSnapshot(query, onNext, onError, onCompletion)

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

query(query, compositeFilter, queryConstraints)

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

Firma:

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

Parámetros

Devoluciones:

Consulta <AppModelType, DbModelType>

Excepciones

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

query(query, queryConstraints)

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

Firma:

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

Parámetros

Devoluciones:

Consulta <AppModelType, DbModelType>

Excepciones

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

function(queryConstraints, ...)

and(queryConstraints)

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

Firma:

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

Parámetros

Devoluciones:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

or(queryConstraints)

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

Firma:

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

Parámetros

Devoluciones:

QueryCompositeFilterConstraint

The newly created QueryCompositeFilterConstraint .

function(reference, ...)

addDoc(reference, data)

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

Firma:

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

Parámetros

Devoluciones:

Promise< DocumentReference <AppModelType, DbModelType>>

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

collection(reference, path, pathSegments)

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

Firma:

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

Parámetros

Devoluciones:

ColecciónReferencia < DocumentData , DocumentData >

The CollectionReference instance.

Excepciones

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

collection(reference, path, pathSegments)

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

Firma:

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

Parámetros

Devoluciones:

ColecciónReferencia < DocumentData , DocumentData >

The CollectionReference instance.

Excepciones

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

deleteDoc(reference)

Deletes the document referred to by the specified DocumentReference .

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

doc(reference, path, pathSegments)

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

Firma:

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

Parámetros

Devoluciones:

Referencia de documento <AppModelType, DbModelType>

The DocumentReference instance.

Excepciones

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

doc(reference, path, pathSegments)

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

Firma:

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

Parámetros

Devoluciones:

Referencia de documento < DocumentData , DocumentData >

The DocumentReference instance.

Excepciones

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

getDoc(reference)

Reads the document referred to by this DocumentReference .

Firma:

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

Parámetros

Devoluciones:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

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

getDocFromCache(reference)

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

Firma:

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

Parámetros

Devoluciones:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

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

getDocFromServer(reference)

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

Firma:

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

Parámetros

Devoluciones:

Promise< DocumentSnapshot <AppModelType, DbModelType>>

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

onSnapshot(reference, observer)

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

onSnapshot(reference, options, observer)

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

onSnapshot(reference, onNext, onError, onCompletion)

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

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

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

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

Firma:

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

Parámetros

Devoluciones:

Darse de baja

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

setDoc(reference, data)

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

setDoc(reference, data, options)

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

updateDoc(reference, data)

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

updateDoc(reference, field, value, moreFieldsAndValues)

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

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

Firma:

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

Parámetros

Devoluciones:

Promesa<nulo>

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

function(settings, ...)

memoryLocalCache(settings)

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

Firma:

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

Parámetros

Devoluciones:

MemoryLocalCache

memoryLruGarbageCollector(settings)

Creates an instance of MemoryLruGarbageCollector .

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

Firma:

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

Parámetros

Devoluciones:

MemoryLruGarbageCollector

persistentLocalCache(settings)

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

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

Firma:

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

Parámetros

Devoluciones:

PersistentLocalCache

persistentSingleTabManager(settings)

Creates an instance of PersistentSingleTabManager .

Firma:

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

Parámetros

Devoluciones:

PersistentSingleTabManager

function(snapshot, ...)

endAt(snapshot)

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

Firma:

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

Parámetros

Devoluciones:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

endBefore(snapshot)

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

Firma:

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

Parámetros

Devoluciones:

QueryEndAtConstraint

A QueryEndAtConstraint to pass to query()

startAfter(snapshot)

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

Firma:

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

Parámetros

Devoluciones:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query()

startAt(snapshot)

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

Firma:

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

Parámetros

Devoluciones:

QueryStartAtConstraint

A QueryStartAtConstraint to pass to query() .

CACHE_SIZE_UNLIMITED

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

Firma:

CACHE_SIZE_UNLIMITED = -1

AddPrefixToKeys

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

Firma:

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

Tipo de campo agregado

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

Firma:

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

Datos de especificación agregados

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

Firma:

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

AggregateType

Union type representing the aggregate type to be performed.

Firma:

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

ChildUpdateFields

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

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

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

Firma:

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

Tipo de cambio de documento

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

Firma:

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

FirestoreErrorCode

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

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

Firma:

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

FirestoreLocalCache

Union type from all supported SDK cache layer.

Firma:

export declare type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

ListenSource

Describe the source a query listens to.

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

Firma:

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

MemoryGarbageCollector

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

Firma:

export declare type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;

NestedUpdateFields

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

Firma:

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

OrderByDirection

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

Firma:

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

PartialWithFieldValue

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

Firma:

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

PersistentTabManager

A union of all available tab managers.

Firma:

export declare type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

Primitivo

Primitive types.

Firma:

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

QueryConstraintType

Describes the different query constraints available in this SDK.

Firma:

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

Restricción de filtro de consulta

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

Firma:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

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

Firma:

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

Establecer opciones

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

Firma:

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

Estado de tarea

Representa el estado de las tareas de carga de paquetes.

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

Firma:

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

unión a la intersección

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

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

Firma:

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

Actualizar datos

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

Firma:

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

DondeFilterOp

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

Firma:

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

WithFieldValue

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

Firma:

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