d11 theme
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
rdrew f035d16951 lots of layout changes + sidbars 2 weeks ago
..
.github lots of layout changes + sidbars 2 weeks ago
Iterator lots of layout changes + sidbars 2 weeks ago
Iterator.concat lots of layout changes + sidbars 2 weeks ago
Iterator.from lots of layout changes + sidbars 2 weeks ago
Iterator.prototype lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.constructor lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.drop lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.every lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.filter lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.find lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.flatMap lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.forEach lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.includes lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.map lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.reduce lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.some lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.take lots of layout changes + sidbars 2 weeks ago
Iterator.prototype.toArray lots of layout changes + sidbars 2 weeks ago
Iterator.zip lots of layout changes + sidbars 2 weeks ago
Iterator.zipKeyed lots of layout changes + sidbars 2 weeks ago
IteratorHelperPrototype lots of layout changes + sidbars 2 weeks ago
WrapForValidIteratorPrototype lots of layout changes + sidbars 2 weeks ago
aos lots of layout changes + sidbars 2 weeks ago
test lots of layout changes + sidbars 2 weeks ago
.nycrc lots of layout changes + sidbars 2 weeks ago
CHANGELOG.md lots of layout changes + sidbars 2 weeks ago
LICENSE lots of layout changes + sidbars 2 weeks ago
README.md lots of layout changes + sidbars 2 weeks ago
auto.js lots of layout changes + sidbars 2 weeks ago
eslint.config.mjs lots of layout changes + sidbars 2 weeks ago
index.json lots of layout changes + sidbars 2 weeks ago
package.json lots of layout changes + sidbars 2 weeks ago
shim.js lots of layout changes + sidbars 2 weeks 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, Safari <= v17.1, Firefox <= v125: not implemented
  • node v22, Chrome v122 - v130: has a bug where { next: null } is not properly rejected
  • node v22 - v24, Chrome v122 - v134: missing early-error IteratorClose when argument validation fails (e.g., non-callable mapper does not call the iterator's return method)
  • all environments lack Iterator.concat, Iterator.zip, Iterator.zipKeyed, Iterator.prototype.includes

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:

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