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

Metody

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

Zwroty:

tablica<DocumentChange<AppModelType, DbModelType>>

QuerySnapshot.forEach()

Wylicza wszystkie dokumenty w QuerySnapshot.

Podpis:

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

Parametry

Zwroty:

nieważne