Function flatSync

Flattens an input sync iterable up to a specified depth. Returns a new synchronous iterable.

Returns

A function that accepts an input sync iterable and returns a new synchronous iterable.

Example

const input = [1, [2, 3], [4, [5]]];
const flatSyncIterable = flatSync<number>(1)(input);

for (const x of flatSyncIterable) {
  console.log(x); // Logs 1, 2, 3, 4, [5]
}

Remarks

Available as flat when imported from peter-piper/sync.