All files / iterable/src chunk.ts

100% Statements 11/11
100% Branches 4/4
100% Functions 3/3
100% Lines 10/10

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49                                                  1x 1x 1x     1x         1x 5x 2x 2x         1x 1x        
/**
 * Chunks the elements of an {@link Iterable}.
 *
 * @remarks
 * Behavior for negative `chunkSize` is not defined.
 *
 * @example
 * Chunk in pairs
 * ```ts
 * const makePairs = chunk(2);
 * const pairs = makePairs([1,2,3,4,5]);
 * console.log(pairs); // [[1,2], [3,4], [5]]
 * ```
 *
 * @see {@link concat}, {@link flatMap}, {@link pairwise} and {@link zip} for
 * similar operations.
 *
 * @typeParam T - the {@link Iterable} value type
 * @param chunkSize - the chunk size
 * @returns The chunked {@link Iterable}
 */
type Chunk = <T>(
  chunkSiz: number
) => (iterable: Iterable<T>) => IterableIterator<T[]>;
 
export const chunk: Chunk = <T>(chunkSize: number) => {
  if (process.env.NODE_ENV !== "production") {
    console.assert(chunkSize >= 1, "chunkSize must be >= 1");
  }
 
  return function* (
    iterable: Iterable<T>,
    // internal variables:
    buffer: T[] = []
  ): IterableIterator<T[]> {
    for (const value of iterable) {
      if (buffer.push(value) >= chunkSize) {
        yield buffer;
        buffer = [];
      }
    }
 
    // last buffer was incomplete
    if (buffer.length) {
      yield buffer;
    }
  };
};