@naturalcycles/js-lib/src/iter/iterable2.ts

Standard library for universal (browser + Node.js) javascript

import type { AbortableMapper, AbortablePredicate } from '../types.js'
import { END, SKIP } from '../types.js'

/**
 * Iterable2 is a wrapper around Iterable that implements "Iterator Helpers proposal":
 * https://github.com/tc39/proposal-iterator-helpers
 *
 * Iterable2 can be removed after the proposal is widely implemented in Node & browsers.
 *
 * @experimental
 */
export class Iterable2<T> implements Iterable<T> {
  private constructor(private it: Iterable<T>) {}

  static of<T>(it: Iterable<T>): Iterable2<T> {
    return new Iterable2(it)
  }

  static empty<T>(): Iterable2<T> {
    return new Iterable2([])
  }

  [Symbol.iterator](): Iterator<T> {
    return this.it[Symbol.iterator]()
  }

  toArray(): T[] {
    return [...this.it]
  }

  forEach(cb: (v: T, i: number) => any | typeof END): void {
    let i = 0
    for (const v of this.it) {
      if (cb(v, i++) === END) return
    }
  }

  some(cb: AbortablePredicate<T>): boolean {
    // eslint-disable-next-line unicorn/prefer-array-some
    return !!this.find(cb)
  }

  every(cb: AbortablePredicate<T>): boolean {
    let i = 0
    for (const v of this.it) {
      const r = cb(v, i++)
      if (r === END || !r) return false
    }
    return true
  }

  find(cb: AbortablePredicate<T>): T | undefined {
    let i = 0
    for (const v of this.it) {
      const r = cb(v, i++)
      if (r === END) return
      if (r) return v
    }
  }

  filter(cb: AbortablePredicate<T>): Iterable2<T> {
    const { it } = this

    return new Iterable2<T>({
      *[Symbol.iterator]() {
        let i = 0
        for (const v of it) {
          const r = cb(v, i++)
          if (r === END) return
          if (r) yield v
        }
      },
    })
  }

  map<OUT>(mapper: AbortableMapper<T, OUT>): Iterable2<OUT> {
    const { it } = this

    return new Iterable2<OUT>({
      *[Symbol.iterator]() {
        let i = 0
        for (const v of it) {
          const r = mapper(v, i++)
          if (r === END) return
          if (r === SKIP) continue
          yield r
        }
      },
    })
  }
}