es-iterator-helpers

es-iterator-helpers

An ESnext spec-compliant sync iterator helpers shim/polyfill/replacement that works as far down as ES3.

This package implements the es-shim API “multi” interface. It works in an ES3-supported environment and complies with the spec.

Because the Iterator.prototype methods depend on a receiver (the this value), the main export in each subdirectory takes the string to operate on as the first argument.

The main export of the package itself is simply an array of the available directory names. It’s sole intended use is for build tooling and testing.

Supported things

• Iterator constructor
• Iterator.from
• Iterator.prototype.constructor
• Iterator.prototype.drop
• Iterator.prototype.every
• Iterator.prototype.filter
• Iterator.prototype.find
• Iterator.prototype.flatMap
• Iterator.prototype.forEach
• Iterator.prototype.map
• Iterator.prototype.reduce
• Iterator.prototype.some
• Iterator.prototype.take
• Iterator.prototype.toArray

Getting started

npm install --save es-iterator-helpers

Usage/Examples

const map = require('es-iterator-helpers/Iterator.prototype.map');
const toArray = require('es-iterator-helpers/Iterator.prototype.toArray');
const assert = require('assert');

const iterator = [1, 2, 3].values();

const mapped = map(iterator, (x) => x + 10);
assert.deepEqual(
	mapped.next(),
    {
        done: false,
        value: 11,
    }
);
assert.deepEqual(
    toArray(mapped),
    [12, 13]
);

require('./auto'); // shim all of the methods

require('./Iterator.prototype.map/auto'); // shim the “map” method

Tests

Simply clone the repo, npm install, and run npm test

Changelog

v1.0.2 - 2023-02-09

Commits

• [Refactor] inline 2023 impls of Iterator AOs until es-abstract is published with them b9c80c5
• [Fix] ensure calling .return does not invoke the next iteration 9e28ed5
• [Fix] map: pass the proper index argument to the mapper 125e3ca
• [Deps] update internal-slot 43351b6