fix comments

pull/21833/head
Michael Telatynski 2020-08-04 22:03:30 +01:00
parent ed4a427287
commit f5d75bc078
1 changed files with 9 additions and 12 deletions

View File

@ -18,11 +18,10 @@ import { arrayDiff, arrayMerge, arrayUnion } from "./arrays";
/** /**
* Determines the keys added, changed, and removed between two Maps. * Determines the keys added, changed, and removed between two Maps.
* For changes, simple triple equal comparisons are done, not in-depth * For changes, simple triple equal comparisons are done, not in-depth tree checking.
* tree checking. * @param a The first Map. Must be defined.
* @param a The first object. Must be defined. * @param b The second Map. Must be defined.
* @param b The second object. Must be defined. * @returns The difference between the keys of each Map.
* @returns The difference between the keys of each object.
*/ */
export function mapDiff<K, V>(a: Map<K, V>, b: Map<K, V>): { changed: K[], added: K[], removed: K[] } { export function mapDiff<K, V>(a: Map<K, V>, b: Map<K, V>): { changed: K[], added: K[], removed: K[] } {
const aKeys = [...a.keys()]; const aKeys = [...a.keys()];
@ -35,13 +34,11 @@ export function mapDiff<K, V>(a: Map<K, V>, b: Map<K, V>): { changed: K[], added
} }
/** /**
* Gets all the key changes (added, removed, or value difference) between * Gets all the key changes (added, removed, or value difference) between two Maps.
* two Maps. Triple equals is used to compare values, not in-depth tree * Triple equals is used to compare values, not in-depth tree checking.
* checking. * @param a The first Map. Must be defined.
* @param a The first object. Must be defined. * @param b The second Map. Must be defined.
* @param b The second object. Must be defined. * @returns The keys which have been added, removed, or changed between the two Maps.
* @returns The keys which have been added, removed, or changed between the
* two objects.
*/ */
export function mapKeyChanges<K, V>(a: Map<K, V>, b: Map<K, V>): K[] { export function mapKeyChanges<K, V>(a: Map<K, V>, b: Map<K, V>): K[] {
const diff = mapDiff(a, b); const diff = mapDiff(a, b);