zlwu dd667101ef first commit 1 year ago
..
.github dd667101ef first commit 1 year ago
Iterator dd667101ef first commit 1 year ago
Iterator.concat dd667101ef first commit 1 year ago
Iterator.from dd667101ef first commit 1 year ago
Iterator.prototype dd667101ef first commit 1 year ago
Iterator.prototype.constructor dd667101ef first commit 1 year ago
Iterator.prototype.drop dd667101ef first commit 1 year ago
Iterator.prototype.every dd667101ef first commit 1 year ago
Iterator.prototype.filter dd667101ef first commit 1 year ago
Iterator.prototype.find dd667101ef first commit 1 year ago
Iterator.prototype.flatMap dd667101ef first commit 1 year ago
Iterator.prototype.forEach dd667101ef first commit 1 year ago
Iterator.prototype.map dd667101ef first commit 1 year ago
Iterator.prototype.reduce dd667101ef first commit 1 year ago
Iterator.prototype.some dd667101ef first commit 1 year ago
Iterator.prototype.take dd667101ef first commit 1 year ago
Iterator.prototype.toArray dd667101ef first commit 1 year ago
Iterator.zip dd667101ef first commit 1 year ago
Iterator.zipKeyed dd667101ef first commit 1 year ago
IteratorHelperPrototype dd667101ef first commit 1 year ago
WrapForValidIteratorPrototype dd667101ef first commit 1 year ago
aos dd667101ef first commit 1 year ago
test dd667101ef first commit 1 year ago
.eslintrc dd667101ef first commit 1 year ago
.nycrc dd667101ef first commit 1 year ago
CHANGELOG.md dd667101ef first commit 1 year ago
LICENSE dd667101ef first commit 1 year ago
README.md dd667101ef first commit 1 year ago
auto.js dd667101ef first commit 1 year ago
index.json dd667101ef first commit 1 year ago
package.json dd667101ef first commit 1 year ago
shim.js dd667101ef first commit 1 year ago

README.md

es-iterator-helpers Version Badge

github actions coverage License Downloads

npm badge

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 iterator helpers spec and the iterator sequencing spec.

Because the Iterator.prototype methods depend on a receiver (the this value), the main export in each subdirectory takes the iterator 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

Environments where this is needed

  • node v22, Chrome >= v122: has a bug
  • node < v22, Chrome < v122, Safari <= v17.1, Firefox <= v125: not implemented
  • all environments lack Iterator.concat, Iterator.zip, Iterator.zipKeyed

Getting started

npm install --save es-iterator-helpers

Usage/Examples

Using explicit imports:

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]
);

Shim using require:

require('es-iterator-helpers/auto'); // shim all of the methods

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

Shim using import syntax:

[](#preventEval)

import 'es-iterator-helpers/auto'; // shim all of the methods

import 'es-iterator-helpers/Iterator.prototype.map/auto'; // shim the “map” method

Tests

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