Метаданные о снимке, описывающие состояние снимка.
Подпись:
export declare class SnapshotMetadata
Характеристики
Свойство | Модификаторы | Тип | Описание |
---|---|---|---|
из кэша | логическое значение | Значение true, если снимок был создан на основе кэшированных данных, а не на основе гарантированно актуальных данных сервера. Если ваш прослушиватель согласился на обновление метаданных (через SnapshotListenOptions ), вы получите еще один снимок с fromCache , установленным в значение false, как только клиент получит актуальные данные от серверной части. | |
имеетPendingWrites | логическое значение | Значение true, если снимок содержит результаты локальных записей (например, вызовы set() или update() ), которые еще не были переданы на серверную часть. Если ваш прослушиватель согласился на обновление метаданных (через SnapshotListenOptions ), вы получите еще один снимок с hasPendingWrites равным false, как только записи будут переданы на серверную часть. |
Методы
Метод | Модификаторы | Описание |
---|---|---|
isEqual(другое) | Возвращает true, если этот SnapshotMetadata равен предоставленному. |
SnapshotMetadata.fromCache
Значение true, если снимок был создан на основе кэшированных данных, а не на основе гарантированно актуальных данных сервера. Если ваш слушатель согласился на обновление метаданных (через SnapshotListenOptions
) вы получите еще один снимок с fromCache
установленным на false, как только клиент получит актуальные данные от серверной части.
Подпись:
readonly fromCache: boolean;
SnapshotMetadata.hasPendingWrites
Значение true, если снимок содержит результаты локальных записей (например, вызовы set()
или update()
), которые еще не были переданы на серверную часть. Если ваш слушатель согласился на обновление метаданных (через SnapshotListenOptions
) вы получите еще один снимок с hasPendingWrites
равным false, как только записи будут переданы на серверную часть.
Подпись:
readonly hasPendingWrites: boolean;
СнапшотМетаданные.isEqual()
Возвращает true, если этот SnapshotMetadata
равен предоставленному.
Подпись:
isEqual(other: SnapshotMetadata): boolean;
Параметры
Параметр | Тип | Описание |
---|---|---|
другой | Метаданные моментального снимка | SnapshotMetadata для сравнения. |
Возврат:
логическое значение
true, если эти SnapshotMetadata
равны предоставленным.