Need private packages and team management tools?Check out npm Teams »

es-get-iterator

1.1.0 • Public • Published

es-get-iterator Version Badge

Build Status dependency status dev dependency status License Downloads

npm badge

Get an iterator for any JS language value. Works robustly across all environments, all versions.

In modern engines, value[Symbol.iterator]() is sufficient to produce an iterator (an object with a .next method) for that object. However, older engines:

  • may lack Symbol support altogether
  • may have Symbol.iterator but not implement it on everything it should, like arguments objects
  • may have Map and Set, but a non-standard name for the iterator-producing method (.iterator or ['@@iterator'], eg)
  • may be old versions of Firefox that produce values until they throw a StopIteration exception, rather than having iteration result objects
  • may be polyfilled/shimmed/shammed, with es6-shim or core-js or similar

This library attempts to provide an abstraction over all that complexity!

In node v13+, exports is used to provide a lean implementation that lacks all the complexity described above, in combination with the browser field so that bundlers will pick up the proper implementation.

Targeting browsers with Symbol support

If you are targeting browsers that definitely all have Symbol support, then you can configure your bundler to replace require('has-symbols')() with a literal true, which should allow dead code elimination to reduce the size of the bundled code.

With @rollup/plugin-replace

// rollup.config.js
 
import replace from '@rollup/plugin-replace';
 
export default {
    ...
    plugins: [
        replace({
            "require('has-symbols')()": 'true',
            delimiters: ['', '']
        })
    ]
};

Example

var getIterator = require('es-get-iterator');
var assert = require('assert');
 
var iterator = getIterator('a 💩');
assert.deepEqual(
    [iterator.next(), iterator.next(), iterator.next(), iterator.next()],
    [{ done: false, value: 'a' }, { done: false, value: ' ' }, { done: false, value: '💩' }, { done: true, value: undefined }]
);
 
var iterator = getIterator([1, 2]);
assert.deepEqual(
    [iterator.next(), iterator.next(), iterator.next()],
    [{ done: false, value: 1 }, { done: false, value: 2 }, { done: true, value: undefined }]
);
 
var iterator = getIterator(new Set([1, 2]));
assert.deepEqual(
    [iterator.next(), iterator.next(), iterator.next()],
    [{ done: false, value: 1 }, { done: false, value: 2 }, { done: true, value: undefined }]
);
 
var iterator = getIterator(new Map([[1, 2], [3, 4]]));
assert.deepEqual(
    [iterator.next(), iterator.next(), iterator.next()],
    [{ done: false, value: [1, 2] }, { done: false, value: [3, 4] }, { done: true, value: undefined }]
);

Tests

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

Install

npm i es-get-iterator

DownloadsWeekly Downloads

1,365,101

Version

1.1.0

License

MIT

Unpacked Size

26.1 kB

Total Files

19

Last publish

Collaborators

  • avatar