Um QueryDocumentSnapshot contém dados lidos de um documento no banco de dados do Firestore como parte de uma consulta. É garantida a existência do documento e seus dados podem ser extraídos com .data() ou .get(<field>) para obter um campo específico.
Um QueryDocumentSnapshot oferece a mesma superfície de API que um DocumentSnapshot . Como os resultados da consulta contêm apenas documentos existentes, a propriedade exists sempre será verdadeira e data() nunca retornará 'indefinido'.
Assinatura:
export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType>
Estende: DocumentSnapshot <AppModelType, DbModelType>
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 com seu valor final serão retornados como null . Você pode substituir isso passando um objeto de opções. |
QueryDocumentSnapshot.data()
Recupera todos os campos do documento como um Object .
Por padrão, os valores serverTimestamp() que ainda não foram definidos com seu valor final serão retornados como null . Você pode substituir isso passando um objeto de opções.
Assinatura:
/** @override */
data(options?: SnapshotOptions): AppModelType;
Parâmetros
| Parâmetro | Tipo | Descrição |
|---|---|---|
| opções | Opções de instantâneo | Um objeto de opções para configurar como os dados são recuperados do instantâneo (por exemplo, o comportamento desejado para carimbos de data/hora do servidor que ainda não foram definidos com seu valor final). |
Retorna:
AppModelType
Um Object que contém todos os campos do documento.