feat: make collectWith return the provided object

This will make it consistent with other 'collection' methods. ORIGINAL-PR-URL: metarhia/common#278
metarhia · Sep 13, 2020 · 49cbdff · 49cbdff
1 parent 43bb512
commit 49cbdff
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/lib/iterator.js b/lib/iterator.js
@@ -111,6 +111,7 @@ class Iterator {
 
   collectWith(obj, collector) {
     this.forEach(element => collector(obj, element));
+    return obj;
   }
 
   toArray() {

diff --git a/test/iterator.js b/test/iterator.js
@@ -440,6 +440,14 @@ metatests.test(
   }
 );
 
+metatests.test('Iterator.collectWith must return provided object', test => {
+  const set = iter(array).collectWith(new Set(), (obj, element) => {
+    obj.add(element);
+  });
+  test.strictSame([...set.values()], array);
+  test.end();
+});
+
 metatests.testSync('Iterator.enumerate must return tuples', test => {
   let i = 0;
   iter(array)