QuerySnapshot class

Pole QuerySnapshot zawiera 0 lub więcej obiektów DocumentSnapshot reprezentujących wyniki zapytania. Dostęp do dokumentów jest możliwy w postaci tablicy za pomocą właściwości docs lub w formie wyliczanych przy użyciu 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> 

Właściwości

Właściwość Modyfikatory Typ Opis
dokumenty Tablica<QueryDocumentSnapshot<AppModelType, DbModelType>> Tablica wszystkich dokumentów w zasobniku QuerySnapshot.
puste wartość logiczna Prawda, jeśli w QuerySnapshot nie ma dokumentów.
metadane, SnapshotMetadata Metadane dotyczące tego zrzutu, w tym informacje o jego źródle i ewentualnych zmianach, które zostały wprowadzone lokalnie.
zapytanie Zapytanie<AppModelType, DbModelType> Zapytanie, które wywołało funkcję get lub onSnapshot, aby uzyskać ten QuerySnapshot.
size [rozmiar] liczba Liczba dokumentów w zasobniku QuerySnapshot.

Metody

Metoda Modyfikatory Opis
docChanges(opcje) Zwraca tablicę zmian w dokumentach od momentu utworzenia ostatniego zrzutu. Jeśli jest to pierwszy zrzut, wszystkie dokumenty będą widoczne na liście jako „dodane” zmian.
forEach(callback, thisArg) Wylicza wszystkie dokumenty w QuerySnapshot.

QuerySnapshot.docs

Tablica ze wszystkimi dokumentami w zasobniku QuerySnapshot.

Podpis:

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

QuerySnapshot:puste

Prawda, jeśli w QuerySnapshot nie ma dokumentów.

Podpis:

get empty(): boolean;

QuerySnapshot.metadata

Metadane dotyczące tego zrzutu, w tym informacje o jego źródle i ewentualnych zmianach, które zostały wprowadzone lokalnie.

Podpis:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

Zapytanie, które wywołało funkcję get lub onSnapshot, aby uzyskać QuerySnapshot.

Podpis:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

Liczba dokumentów w QuerySnapshot.

Podpis:

get size(): number;

QuerySnapshot.docChanges()

Zwraca tablicę zmian w dokumentach od momentu utworzenia ostatniego zrzutu. Jeśli jest to pierwszy zrzut, wszystkie dokumenty będą widoczne na liście jako „dodane” zmian.

Podpis:

docChanges(options?: SnapshotListenOptions): Array<DocumentChange<AppModelType, DbModelType>>;

Parametry

Parametr Typ Opis
opcje SnapshotListenOptions SnapshotListenOptions, które określają, czy zmiany tylko metadanych (tj. zmiana tylko wartości DocumentSnapshot.metadata) powinny wywoływać zdarzenia zrzutu.

Zwroty:

tablica<DocumentChange<AppModelType, DbModelType>>

QuerySnapshot.forEach()

Wylicza wszystkie dokumenty w QuerySnapshot.

Podpis:

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

Parametry

Parametr Typ Opis
wywołanie zwrotne (wynik: QueryDocumentSnapshot<AppModelType, DbModelType>) => nieważne Wywołanie zwrotne z parametrem QueryDocumentSnapshot dla każdego dokumentu w zrzucie.
ten argument nieznany Powiązanie this dla wywołania zwrotnego.

Zwroty:

nieważne