Add jsdoc and cover iterator "completed" value

kewisch · Apr 18, 2024 · feba263 · feba263
1 parent 42e16f1
commit feba263
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/lib/ical/recur_iterator.js b/lib/ical/recur_iterator.js
@@ -1385,6 +1385,13 @@ class RecurIterator {
   }
 }
 
+/**
+ * An error indicating that a recurrence rule is invalid and produces no
+ * occurrences.
+ *
+ * @extends {Error}
+ * @class
+ */
 class InvalidRecurrenceRuleError extends Error {
   constructor() {
     super("Recurrence rule has no valid occurrences");

diff --git a/test/recur_iterator_test.js b/test/recur_iterator_test.js
@@ -155,6 +155,7 @@ suite('recur_iterator', function() {
 
       if (options.noInstance) {
         assert.equal(iterator.next(), null);
+        assert.ok(iterator.completed);
         return;
       }
-Original file line number
+Diff line change
@@ Expand Up / @@ -155,6 +155,7 @@ suite('recur_iterator', function() { @@
           if (options.noInstance) {
             assert.equal(iterator.next(), null);
+            assert.ok(iterator.completed);
             return;
           }
@@ Expand Down @@