QuerySnapshot class

QuerySnapshot содержит ноль или более объектов DocumentSnapshot , представляющих результаты запроса. Доступ к документам можно получить как массив через свойство docs или перечислить с помощью метода forEach . Количество документов можно определить с помощью свойств empty и size .

Подпись:

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

Характеристики

Свойство	Модификаторы	Тип	Описание
документы		Массив< QueryDocumentSnapshot <AppModelType, DbModelType>>	Массив всех документов в QuerySnapshot .
пустой		логическое значение	True, если в QuerySnapshot нет документов.
метаданные		Метаданные моментального снимка	Метаданные об этом снимке, его источнике и наличии локальных изменений.
запрос		Запрос <AppModelType, DbModelType>	Запрос, по которому вы вызвали get или onSnapshot , чтобы получить этот QuerySnapshot .
размер		число	Количество документов в QuerySnapshot .

Методы

Метод	Модификаторы	Описание
docChanges(опции)		Возвращает массив изменений документов с момента последнего снимка. Если это первый снимок, все документы будут в списке как «добавленные» изменения.
forEach (обратный вызов, thisArg)		Перечисляет все документы в QuerySnapshot .

QuerySnapshot.docs

Массив всех документов в QuerySnapshot .

Подпись:

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

QuerySnapshot.empty

Истинно, если в QuerySnapshot нет документов. .

Подпись:

get empty(): boolean;

QuerySnapshot.metadata

Метаданные об этом снимке, его источнике и наличии локальных изменений.

Подпись:

readonly metadata: SnapshotMetadata;

QuerySnapshot.query

Запрос, по которому вы вызвали get или onSnapshot , чтобы получить этот QuerySnapshot .

Подпись:

readonly query: Query<AppModelType, DbModelType>;

QuerySnapshot.size

Количество документов в QuerySnapshot .

Подпись:

get size(): number;

QuerySnapshot.docChanges()

Возвращает массив изменений документов с момента последнего снимка. Если это первый снимок, все документы будут в списке как «добавленные» изменения.

Подпись:

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

Параметры

Параметр	Тип	Описание
параметры	Параметры моментального снимка прослушивания	SnapshotListenOptions , которые определяют, должны ли изменения только метаданных (т. е. изменены только DocumentSnapshot.metadata ) инициировать события моментального снимка.

Возврат:

Массив< Изменение Документа <AppModelType, DbModelType>>

QuerySnapshot.forEach()

Перечисляет все документы в QuerySnapshot .

Подпись:

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

Параметры

Параметр	Тип	Описание
перезвонить	(результат: QueryDocumentSnapshot <AppModelType, DbModelType>) => void	Обратный вызов, который будет вызываться с помощью QueryDocumentSnapshot для каждого документа в снимке.
этотArg	неизвестный	Привязка this для обратного вызова.

Возврат:

пустота