QuerySnapshot class

Obiekt QuerySnapshot zawiera zero lub więcej obiektów DocumentSnapshot reprezentujących wyniki zapytania. Dostęp do dokumentów można uzyskać w postaci tablicy za pomocą właściwości docs lub wyliczyć za pomocą metody forEach . Liczbę dokumentów można określić za pomocą właściwości empty i size .

Podpis:

export declare class QuerySnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

Nieruchomości

Nieruchomość Modyfikatory Typ Opis
dokumenty Tablica < QueryDocumentSnapshot <AppModelType, DbModelType>> Tablica wszystkich dokumentów w QuerySnapshot .
pusty wartość logiczna Prawda, jeśli w QuerySnapshot nie ma żadnych dokumentów.
zapytanie Zapytanie <AppModelType, DbModelType> Zapytanie, dla którego wywołałeś funkcję getDocs() w celu uzyskania tego QuerySnapshot .
rozmiar numer Liczba dokumentów w QuerySnapshot .

Metody

metoda Modyfikatory Opis
forEach(wywołanie zwrotne, thisArg) Wylicza wszystkie dokumenty w QuerySnapshot .

QuerySnapshot.docs

Tablica wszystkich dokumentów w QuerySnapshot .

Podpis:

get docs(): Array<QueryDocumentSnapshot<AppModelType, DbModelType>>;

ZapytanieSnapshot.puste

Wartość true, jeśli w QuerySnapshot nie ma żadnych dokumentów .

Podpis:

get empty(): boolean;

ZapytanieSnapshot.query

Zapytanie, w którym wywołałeś funkcję getDocs() w celu uzyskania tego QuerySnapshot .

Podpis:

readonly query: Query<AppModelType, DbModelType>;

ZapytanieSnapshot.size

Liczba dokumentów w QuerySnapshot .

Podpis:

get size(): number;

ZapytanieSnapshot.forEach()

Wylicza wszystkie dokumenty w QuerySnapshot .

Podpis:

forEach(callback: (result: QueryDocumentSnapshot<AppModelType, DbModelType>) => void, thisArg?: unknown): void;

Parametry

Parametr Typ Opis
oddzwonić (wynik: QueryDocumentSnapshot <AppModelType, DbModelType>) => nieważne Wywołanie zwrotne, które ma zostać wywołane z QueryDocumentSnapshot dla każdego dokumentu w migawce.
tenArg nieznany Wiązanie this dla wywołania zwrotnego.

Zwroty:

próżnia