feat(collections): support Iterable argument in slidingWindows()

[Liam-Tait]

Support Iterable for collections slidingWindows

Maintains the current sliding windows for Arrays for the empty Array case. Using the iterable version would change the output from an empty array causing the case is covered by the "slidingWindows() handles empty Array" test to fail.

Example:

slidingWindows(new Array(3), 1)

// The difference is 
// [ [ <1 empty item> ], [ <1 empty item> ], [ <1 empty item> ] ]
// vs
// [ [ undefined ], [ undefined ], [ undefined ] ]

If the array specific implementation was removed, this would become a breaking change

With an infinite iterator this function would never return.
I added a maxWindows option that limits the number of windows created which would be useful to prevent that case. (maybe it should throw instead?)

However I can remove if we think a seperate take function is better
or the onus is on the user
e.g

function* take<T>(iterable: Iterable<T>, count: number): Iterable<T> {
  let i = 0;
  for (const item of iterable) {
    if (i++ >= count) {
      break;
    }
    yield item;
  }
}
function* infiniteNumbers() {
  let i = 0;
  while (true) {
    yield i++;
  }
}

slidingWindows(
  take(infiniteNumbers(), 5),
  3,
); // [ [ 0, 1, 2 ], [ 1, 2, 3 ], [ 2, 3, 4 ] ]

#5470

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.26%. Comparing base (b3e1ebb) to head (d40d2a6).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #5916   +/-   ##
=======================================
  Coverage   96.25%   96.26%           
=======================================
  Files         489      489           
  Lines       39457    39499   +42     
  Branches     5824     5839   +15     
=======================================
+ Hits        37980    38022   +42     
  Misses       1433     1433           
  Partials       44       44           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Liam-Tait]

On second thought, maxWindows is not really needed.

Added comment to the tracking issue to discuss