iterator-helpers-typings
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

iterator-helpers-typings

TypeScript typings for TC39 iterator helpers proposal, already implemented by V8 and available with Chrome and Node 22+
As of May 2024, this TC39 proposal is on stage 3 but has not been yet integrated to TypeScript. This might be related to some breaking changes... Anyway if you want to start using with TypeScript this awesome functional API bringing lazy sequences, first install the typings with npm or yarn as follow:

npm install -D iterator-helpers-typings

Then, anywhere in your TypeScript codebase, you need to import the typings:

import 'iterator-helpers-typings';

Once this is done you will be able to use iterators in a functionnal way \o/

Iterator
  .from('Hello world iterators!')
  .flatMap(x => [x, ' '])
  .toArray()
  .join('')
// 'H e l l o   w o r l d   i t e r a t o r s ! '

You may think the example above is not mindblowing... Fair enough, now if you try to combine generators with iterator helpers, you have at your disposal lazy infinite sequences! Below as an example an implementation of the Sieve of Eratosthenes leveraging on generators and itrator helpers:

function *generateNaturals(n: number) {
    yield n;
    yield* generateNaturals(n + 1);
 }

 const naturals = generateNaturals(2);


 function *sieve(seq: Iterator<number>) {
    const prime = seq.next().value;
    yield prime;
    yield* sieve(seq.filter(n => n % prime !== 0));
 }

 const primes = sieve(naturals);

 // Log the 10 first prime numbers greater than 42
console.log(
  primes
    .filter(p => p > 42)
    .take(10)
    .toArray()
);

Package Sidebar

Install

npm i iterator-helpers-typings

Weekly Downloads

7

Version

1.0.1

License

ISC

Unpacked Size

5.97 kB

Total Files

6

Last publish

Collaborators

  • alexvictoor