Um QueryDocumentSnapshot contém dados lidos de um documento no seu banco de dados do Firestore como parte de uma consulta. O documento existe, e os dados dele podem ser extraídos com .data() ou .get(<field>) para acessar um campo específico.
Um QueryDocumentSnapshot oferece a mesma plataforma de API que uma DocumentSnapshot. Como os resultados da consulta contêm apenas documentos existentes, a propriedade exists sempre será verdadeira e data() nunca retornará "undefined".
Assinatura:
export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType>
Estende: DocumentSnapshot<AppModelType, DBMModelType>
Métodos
| Método | Modificadores | Descrição |
|---|---|---|
| dados(opções) | Recupera todos os campos do documento como um Object.Por padrão, os valores serverTimestamp() que ainda não foram definidos para o valor final serão retornados como null. Você pode substituir isso transmitindo um objeto de opções. |
QueryDocumentSnapshot.data()
Recupera todos os campos no documento como um Object.
Por padrão, os valores serverTimestamp() que ainda não foram definidos para o valor final serão retornados como null. Você pode substituir isso transmitindo um objeto de opções.
Assinatura:
/** @override */
data(options?: SnapshotOptions): AppModelType;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| options | SnapshotOptions (em inglês) | Um objeto de opções para configurar como os dados são recuperados do snapshot (por exemplo, o comportamento esperado para carimbos de data/hora do servidor que ainda não foram definidos com o valor final). |
Retorna:
Tipo de modelo de aplicativo
Um Object contendo todos os campos do documento.