SnapshotMetadata class

有关快照的元数据,用于描述快照的状态。

签名

export declare class SnapshotMetadata 

属性

属性 修饰符 类型 说明
fromCache 布尔值 如果快照是根据缓存的数据创建的,而不是保证为最新的服务器数据创建的,则为 true。如果您的监听器已选择接收元数据更新(通过 SnapshotListenOptions),您会在客户端从后端收到最新数据后收到另一个 fromCache 设置为 false 的快照。
hasPendingWrites 布尔值 如果快照包含尚未提交到后端的本地写入(例如 set()update() 调用)的结果,则为 true。如果您的监听器已选择接收元数据更新(通过 SnapshotListenOptions),您将在写入提交到后端后收到另一个 hasPendingWrites 等于 false 的快照。

方法

方法 修饰符 说明
isEqual(other) 如果此 SnapshotMetadata 等于提供的值,则返回 true。

SnapshotMetadata.fromCache

如果快照是根据缓存的数据创建的,而不是保证为最新的服务器数据创建的,则为 true。如果您的监听器已选择接收元数据更新(通过 SnapshotListenOptions),您会在客户端从后端收到最新数据后收到另一个 fromCache 设置为 false 的快照。

签名

readonly fromCache: boolean;

SnapshotMetadata.hasPendingWrites

如果快照包含尚未提交到后端的本地写入(例如 set()update() 调用)的结果,则为 true。如果您的监听器已选择接收元数据更新(通过 SnapshotListenOptions),您将在写入提交到后端后收到另一个 hasPendingWrites 等于 false 的快照。

签名

readonly hasPendingWrites: boolean;

SnapshotMetadata.isEqual()

如果此 SnapshotMetadata 等于提供的值,则返回 true。

签名

isEqual(other: SnapshotMetadata): boolean;

参数

参数 类型 说明
其他 SnapshotMetadata 要比较的 SnapshotMetadata

返回

布尔值

如果此 SnapshotMetadata 等于提供的值,则为 true。