Un QuerySnapshot contiene zero o più oggetti DocumentSnapshot che rappresentano i risultati di una query. È possibile accedere ai documenti come array tramite la proprietà docs o enumerarli utilizzando il metodo forEach . Il numero di documenti può essere determinato tramite le proprietà empty e size .
Firma:
export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData>
Proprietà
| Proprietà | Modificatori | Tipo | Descrizione |
|---|---|---|---|
| documenti | Array< QueryDocumentSnapshot <AppModelType, DbModelType>> | Un array di tutti i documenti in QuerySnapshot . | |
| vuoto | booleano | Vero se non sono presenti documenti in QuerySnapshot . | |
| metadati | Metadati dell'istantanea | Metadati su questa istantanea, riguardanti la sua origine e se presenta modifiche locali. | |
| domanda | Domanda <AppModelType, DbModelType> | La query su cui hai chiamato get o onSnapshot per ottenere questo QuerySnapshot . | |
| misurare | numero | Il numero di documenti in QuerySnapshot . |
Metodi
| Metodo | Modificatori | Descrizione |
|---|---|---|
| docModifiche(opzioni) | Restituisce un array delle modifiche apportate al documento dall'ultimo snapshot. Se questa è la prima istantanea, tutti i documenti saranno nell'elenco come modifiche "aggiunte". | |
| forEach(callback, thisArg) | Enumera tutti i documenti in QuerySnapshot . |
QuerySnapshot.docs
Un array di tutti i documenti in QuerySnapshot .
Firma:
get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;
QuerySnapshot.empty
Vero se non sono presenti documenti in QuerySnapshot .
Firma:
get empty(): boolean;
QuerySnapshot.metadata
Metadati su questa istantanea, riguardanti la sua origine e se presenta modifiche locali.
Firma:
readonly metadata: SnapshotMetadata;
QuerySnapshot.query
La query su cui hai chiamato get o onSnapshot per ottenere questo QuerySnapshot .
Firma:
readonly query: Query<AppModelType, DbModelType>;
QuerySnapshot.dimensione
Il numero di documenti in QuerySnapshot .
Firma:
get size(): number;
QuerySnapshot.docChanges()
Restituisce un array delle modifiche apportate al documento dall'ultimo snapshot. Se questa è la prima istantanea, tutti i documenti saranno nell'elenco come modifiche "aggiunte".
Firma:
docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| opzioni | Opzioni di ascolto dell'istantanea | SnapshotListenOptions che controllano se le modifiche relative ai soli metadati (vale a dire solo DocumentSnapshot.metadata modificati) dovrebbero attivare eventi di snapshot. |
Ritorna:
Array< Cambiodocumento <AppModelType, DbModelType>>
QuerySnapshot.forEach()
Enumera tutti i documenti in QuerySnapshot .
Firma:
forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;
Parametri
| Parametro | Tipo | Descrizione |
|---|---|---|
| richiamare | (risultato: QueryDocumentSnapshot <AppModelType, DbModelType>) => void | Un callback da chiamare con un QueryDocumentSnapshot per ogni documento nello snapshot. |
| questoArg | sconosciuto | L'associazione this per la richiamata. |
Ritorna:
vuoto