快照的中繼資料,說明快照的狀態。
簽名:
export declare class SnapshotMetadata
屬性
屬性 | 修飾符 | 類型 | 說明 |
---|---|---|---|
fromCache | 布林值 | 如果快照是透過快取資料建立,而非保證最新的伺服器資料,則為「true」。如果事件監聽器選擇透過 SnapshotListenOptions 更新中繼資料,您會收到另一個快照,將 fromCache 設為 false,然後從後端收到最新資料。 |
|
hasPendingWrites | 布林值 | 如果快照包含尚未提交至後端的本機寫入結果 (例如 set() 或 update() 呼叫),則為「是」。如果事件監聽器選擇透過 SnapshotListenOptions 更新中繼資料,您會在寫入至後端後收到 hasPendingWrites 等於 false 的另一個快照。 |
方法
方法 | 修飾符 | 說明 |
---|---|---|
isEqual(其他) | 如果這個 SnapshotMetadata 等於提供的值,則傳回 true。 |
SnapshotMetadata.fromCache
如果快照是透過快取資料建立,而非保證最新的伺服器資料,則為「true」。如果事件監聽器選擇透過 SnapshotListenOptions
更新中繼資料,您會收到另一個快照,將 fromCache
設為 false,然後從後端收到最新資料。
簽名:
readonly fromCache: boolean;
SnapshotMetadata.hasPendingWrites
如果快照包含尚未提交至後端的本機寫入結果 (例如 set()
或 update()
呼叫),則為「是」。如果事件監聽器選擇更新中繼資料 (透過 SnapshotListenOptions
),您會在寫入後端後收到另一個快照,hasPendingWrites
等於 false。
簽名:
readonly hasPendingWrites: boolean;
SnapshotMetadata.isEqual()
如果這個 SnapshotMetadata
等於提供的值,則傳回 true。
簽名:
isEqual(other: SnapshotMetadata): boolean;
參數
參數 | 類型 | 說明 |
---|---|---|
其他 | SnapshotMetadata | 要用於比較的 SnapshotMetadata 。 |
傳回:
布林值
如果 SnapshotMetadata
等於提供的值,則為 true。