securityos/node_modules/es-iterator-helpers/README.md

4.5 KiB
Raw Blame History

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 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. Its 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

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