Function firstSync

Yields the first element in an input sync iterable that satisfies an optional predicate function. If no predicate is provided, the first element in the iterable is yielded.

Returns

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

Example

const input = [1, 2, 3, 4];
const isEven = (x: number) => x % 2 === 0;
const firstSyncIterable = firstSync<number>(isEven)(input);

for (const x of firstSyncIterable) {
  console.log(x); // Logs 2
}

Remarks

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