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

Metody

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

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

Zwroty:

próżnia