Una QueryDocumentSnapshot
contiene datos leídos de un documento en su base de datos de Firestore como parte de una consulta. Se garantiza que el documento existe y sus datos se pueden extraer con .data()
o .get(<field>)
para obtener un campo específico.
Una QueryDocumentSnapshot
ofrece la misma superficie API que una DocumentSnapshot
. Dado que los resultados de la consulta contienen solo documentos existentes, la propiedad exists
siempre será verdadera y data()
nunca devolverá 'indefinido'.
Firma:
export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType>
Extiende: DocumentSnapshot <Tipo de modelo de aplicación, Tipo de modelo de base de datos>
Métodos
Método | modificadores | Descripción |
---|---|---|
datos (opciones) | Recupera todos los campos del documento como un Object . De forma predeterminada, los valores serverTimestamp() que aún no se han establecido en su valor final se devolverán como null . Puede anular esto pasando un objeto de opciones. |
QueryDocumentSnapshot.data()
Recupera todos los campos del documento como un Object
.
De forma predeterminada, los valores serverTimestamp()
que aún no se han establecido en su valor final se devolverán como null
. Puede anular esto pasando un objeto de opciones.
Firma:
/** @override */
data(options?: SnapshotOptions): AppModelType;
Parámetros
Parámetro | Tipo | Descripción |
---|---|---|
opciones | InstantáneaOpciones | Un objeto de opciones para configurar cómo se recuperan los datos de la instantánea (por ejemplo, el comportamiento deseado para las marcas de tiempo del servidor que aún no se han establecido en su valor final). |
Devoluciones:
Tipo de modelo de aplicación
Object
que contiene todos los campos del documento.