# es-get-iterator

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

Latest version **1.1.3** (published 2023-01-13) · MIT license · 0 weekly downloads

> **Better alternative:** Use v[Symbol.iterator]?.() — Consider using a lighter alternative

## Install

```sh
npm install es-get-iterator
pnpm add es-get-iterator
yarn add es-get-iterator
bun add es-get-iterator
```

## Health

**Score 28/100 (F)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2023-01-13 |
| First published | 2019-11-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/es-get-iterator) |
| Module format | ESM + CommonJS |
| Dependencies | 9 |
| Unpacked size | 30.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Jordan Harband |
| Maintainers | ljharb |
| Keywords | iterator, Symbol.iterator, iterable, collection, next, iteration |

## Links

- npm: https://www.npmjs.com/package/es-get-iterator
- Repository: https://github.com/ljharb/es-get-iterator
- Homepage: https://github.com/ljharb/es-get-iterator#readme
- Issues: https://github.com/ljharb/es-get-iterator/issues
- Funding: https://github.com/sponsors/ljharb
- npm.io page: https://npm.io/package/es-get-iterator

## Dependencies (9)

- [is-map](https://npm.io/package/is-map.md) ^2.0.2
- [is-set](https://npm.io/package/is-set.md) ^2.0.2
- [isarray](https://npm.io/package/isarray.md) ^2.0.5
- [call-bind](https://npm.io/package/call-bind.md) ^1.0.2
- [is-string](https://npm.io/package/is-string.md) ^1.0.7
- [has-symbols](https://npm.io/package/has-symbols.md) ^1.0.3
- [is-arguments](https://npm.io/package/is-arguments.md) ^1.1.1
- [get-intrinsic](https://npm.io/package/get-intrinsic.md) ^1.1.3
- [stop-iteration-iterator](https://npm.io/package/stop-iteration-iterator.md) ^1.0.0

## Recent versions

- 1.1.3 (latest) — 2023-01-13
- 1.1.2 — 2021-01-26
- 1.1.1 — 2020-11-06
- 1.1.0 — 2020-01-26
- 1.0.2 — 2019-12-16
- 1.0.1 — 2019-11-28
- 1.0.0 — 2019-11-26

## README

# es-get-iterator <sup>[![Version Badge][npm-version-svg]][package-url]</sup>

[![dependency status][deps-svg]][deps-url]
[![dev dependency status][dev-deps-svg]][dev-deps-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]

[![npm badge][npm-badge-png]][package-url]

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`

```js
// rollup.config.js

import replace from '@rollup/plugin-replace';

export default {
	...
	plugins: [
		replace({
			"require('has-symbols')()": 'true',
			delimiters: ['', '']
		})
	]
};
```

## Example

```js
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`

[package-url]: https://npmjs.org/package/es-get-iterator
[npm-version-svg]: https://versionbadg.es/ljharb/es-get-iterator.svg
[deps-svg]: https://david-dm.org/ljharb/es-get-iterator.svg
[deps-url]: https://david-dm.org/ljharb/es-get-iterator
[dev-deps-svg]: https://david-dm.org/ljharb/es-get-iterator/dev-status.svg
[dev-deps-url]: https://david-dm.org/ljharb/es-get-iterator#info=devDependencies
[npm-badge-png]: https://nodei.co/npm/es-get-iterator.png?downloads=true&stars=true
[license-image]: https://img.shields.io/npm/l/es-get-iterator.svg
[license-url]: LICENSE
[downloads-image]: https://img.shields.io/npm/dm/es-get-iterator.svg
[downloads-url]: https://npm-stat.com/charts.html?package=es-get-iterator

---
_Source: https://npm.io/package/es-get-iterator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._