Skip to content

Commit

Permalink
digiwf-cypress add code comments
Browse files Browse the repository at this point in the history
  • Loading branch information
simonhir committed Jun 18, 2024
1 parent 56b2e48 commit ac445dd
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions digiwf-cypress/cypress/components/nav.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,11 @@ class Nav {
return inProgressGroupTasks;
}

/**
* Collects task counts for different pages and saves them via cypress alias.
* @param prefix The prefix to use for the alias name.
* @param types A list of pages to collect the metrics for. Allowed values are "myTasks", "openGroupTasks" and "inProgressGroupTasks". Default is all of them.
*/
gatherTaskMetrics(
prefix,
types = ["myTasks", "openGroupTasks", "inProgressGroupTasks"]
Expand All @@ -92,6 +97,12 @@ class Nav {
}
}

/**
* Compares two via {@link gatherTaskMetrics} collected task counts.
* @param prefix1 Prefix used for the first collection.
* @param prefix2 Prefix used for the second collection.
* @param differences Map of differences between first and second collections.
*/
compareTaskMetrics(prefix1, prefix2, differences) {
for (const key in differences) {
const value = differences[key];
Expand Down

0 comments on commit ac445dd

Please sign in to comment.