有关快照的元数据,描述快照的状态。
签名:
export declare class SnapshotMetadata
特性
财产 | 修饰符 | 类型 | 描述 |
---|---|---|---|
来自缓存 | 布尔值 | 如果快照是根据缓存数据而不是保证最新的服务器数据创建的,则为 true。如果您的监听器选择了元数据更新(通过SnapshotListenOptions ),一旦客户端从后端收到最新数据,您将收到另一个fromCache 设置为 false 的快照。 | |
有待写入 | 布尔值 | 如果快照包含尚未提交到后端的本地写入结果(例如set() 或update() 调用),则为 true。如果您的侦听器选择了元数据更新(通过SnapshotListenOptions ),一旦写入已提交到后端,您将收到另一个hasPendingWrites 等于 false 的快照。 |
方法
方法 | 修饰符 | 描述 |
---|---|---|
是否等于(其他) | 如果此SnapshotMetadata 等于提供的值,则返回 true。 |
快照元数据.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
等于提供的值,则为 true。