Métadonnées sur un instantané, décrivant l'état de l'instantané.
Signature:
export declare class SnapshotMetadata
Propriétés
Propriété | Modificateurs | Taper | Description |
---|---|---|---|
à partir du cache | booléen | Vrai si l'instantané a été créé à partir de données mises en cache plutôt que de données de serveur à jour garanties. Si votre auditeur a opté pour les mises à jour des métadonnées (via SnapshotListenOptions ), vous recevrez un autre instantané avec fromCache défini sur false une fois que le client aura reçu des données à jour du backend. | |
hasPendingWrites | booléen | True si l'instantané contient le résultat d'écritures locales (par exemple des appels set() ou update() ) qui n'ont pas encore été validées dans le backend. Si votre auditeur a opté pour les mises à jour des métadonnées (via SnapshotListenOptions ), vous recevrez un autre instantané avec hasPendingWrites égal à false une fois que les écritures auront été validées dans le backend. |
Méthodes
Méthode | Modificateurs | Description |
---|---|---|
est égal (autre) | Renvoie vrai si ce SnapshotMetadata est égal à celui fourni. |
SnapshotMetadata.fromCache
Vrai si l'instantané a été créé à partir de données mises en cache plutôt que de données de serveur à jour garanties. Si votre auditeur a opté pour les mises à jour des métadonnées (via SnapshotListenOptions
), vous recevrez un autre instantané avec fromCache
défini sur false une fois que le client aura reçu des données à jour du backend.
Signature:
readonly fromCache: boolean;
SnapshotMetadata.hasPendingWrites
True si l'instantané contient le résultat d'écritures locales (par exemple des appels set()
ou update()
) qui n'ont pas encore été validées dans le backend. Si votre auditeur a opté pour les mises à jour des métadonnées (via SnapshotListenOptions
), vous recevrez un autre instantané avec hasPendingWrites
égal à false une fois que les écritures auront été validées dans le backend.
Signature:
readonly hasPendingWrites: boolean;
SnapshotMetadata.isEqual()
Renvoie vrai si ce SnapshotMetadata
est égal à celui fourni.
Signature:
isEqual(other: SnapshotMetadata): boolean;
Paramètres
Paramètre | Taper | Description |
---|---|---|
autre | Métadonnées d'instantané | SnapshotMetadata à comparer. |
Retour:
booléen
true si ce SnapshotMetadata
est égal à celui fourni.