Interface : MapDiff

règles . CarteDiff

interface statique

Type MapDiff.

Le type MapDiff représente le résultat de la comparaison de deux objets Rules.Map .

Il n’existe pas de littéral MapDiff à utiliser pour créer des différences. Les objets MapDiff sont renvoyés par des appels à la fonction Rules.Map#diff .

Les fonctions MapDiff décrites ci-dessous sont appelées par chaînage avec Rules.Map#diff . Toutes les fonctions MapDiff renvoient des règles. Définissez les objets répertoriant les clés comparées entre les objets Map.

// Compare two Map objects and return whether the key "a" has been
// affected; that is, key "a" was added or removed, or its value was updated.
request.resource.data.diff(resource.data).affectedKeys().hasOnly(["a"]);

Méthodes

Clés ajoutées

addKeys() renvoie les règles.Set

Renvoie un Rules.Set , qui répertorie toutes les clés que la Map appelant diff() contient et que la Map passée à diff() ne contient pas.

Retour

non-null rules.Set , une liste de clés ajoutées au Rules.Map transmis à la fonction Map.diff() .

Exemple

{"a":1}.diff({}).addedKeys() == ["a"].toSet()

Touches affectées

affectéeKeys() renvoie les règles.Set

Renvoie un Rules.Set , qui répertorie toutes les clés qui ont été ajoutées, supprimées ou modifiées de la Map appelant diff() par rapport à la Map passée à diff() . Cette fonction renvoie l'ensemble équivalent aux résultats combinés de MapDiff.addedKeys() , MapDiff.removedKeys() et MapDiff.changedKeys() .

({"a":0, "c":0, "u":0}).diff({"r":0, "c":1, "u": 0}).affectedKeys() ==
     ["a", "r", "c"].toSet()

Retour

non-null rules.Set , une liste de clés ajoutées, supprimées ou modifiées par Rules.Map transmise à la fonction Map.diff() .

Clés modifiées

changesKeys() renvoie les règles.Set

Renvoie un Rules.Set , qui répertorie toutes les clés qui apparaissent à la fois dans la Map appelant diff() et dans la Map transmise à diff() , mais dont les valeurs ne sont pas égales.

Retour

non-null rules.Set , une liste de clés qui apparaissent dans les deux règles.Map mais dont les valeurs ne sont pas égales.

Exemple

{"a":0}.diff({"a":1, "b":4}).changedKeys() == ["a"].toSet()

Clés supprimées

RemoveKeys() renvoie les règles.Set

Renvoie un Rules.Set , qui répertorie toutes les clés que la Map appelant diff() ne contient pas par rapport à la Map passée à diff() .

Retour

non-null rules.Set , une liste de clés supprimées du Rules.Map transmis à la fonction Map.diff() .

Exemple

{}.diff({"a":1}).removedKeys() == ["a"].toSet()

Clés inchangées

inchangéKeys() renvoie les règles.Set

Renvoie un Rules.Set , qui répertorie toutes les clés qui apparaissent à la fois dans la Map appelant diff() et dans la Map transmise à diff() , et dont les valeurs sont égales.

Retour

non-null rules.Set , une liste de clés qui apparaissent dans les deux règles.Map mais dont les valeurs sont égales.

Exemple

{"a": 0}.diff({"a":0}).unchangedKeys() == ["a"].toSet()