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. | |
metadane | SnapshotMetadata | Metadane dotyczące tej migawki, dotyczące jej źródła i ewentualnych modyfikacji lokalnych. | |
zapytanie | Zapytanie <AppModelType, DbModelType> | Zapytanie, dla którego wywołałeś get lub onSnapshot w celu uzyskania tego QuerySnapshot . | |
rozmiar | numer | Liczba dokumentów w QuerySnapshot . |
Metody
metoda | Modyfikatory | Opis |
---|---|---|
dokumentZmiany(opcje) | Zwraca tablicę zmian dokumentów od czasu ostatniej migawki. Jeżeli jest to pierwsza migawka, wszystkie dokumenty znajdą się na liście jako zmiany „dodane”. | |
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.metadane
Metadane dotyczące tej migawki, dotyczące jej źródła i ewentualnych modyfikacji lokalnych.
Podpis:
readonly metadata: SnapshotMetadata;
ZapytanieSnapshot.query
Zapytanie, dla którego wywołałeś get
lub onSnapshot
, aby uzyskać ten QuerySnapshot
.
Podpis:
readonly query: Query<AppModelType, DbModelType>;
ZapytanieSnapshot.size
Liczba dokumentów w QuerySnapshot
.
Podpis:
get size(): number;
QuerySnapshot.docChanges()
Zwraca tablicę zmian dokumentów od czasu ostatniej migawki. Jeżeli jest to pierwsza migawka, wszystkie dokumenty znajdą się na liście jako zmiany „dodane”.
Podpis:
docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;
Parametry
Parametr | Typ | Opis |
---|---|---|
opcje | Opcje migawki i słuchania | SnapshotListenOptions kontrolujące, czy zmiany dotyczące tylko metadanych (tzn. zmiany tylko DocumentSnapshot.metadata ) powinny wyzwalać zdarzenia migawki. |
Zwroty:
Tablica< Zmiana dokumentu <AppModelType, DbModelType>>
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