# get-iterator

> Get the default iterator or async iterator for an iterable or async iterable

Latest version **2.0.1** (published 2023-08-14) · MIT license · 0 weekly downloads

## Install

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

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2023-08-14 |
| First published | 2018-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 0 |
| Unpacked size | 11.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Alan Shaw |
| Maintainers | achingbrain, alanshaw |
| Keywords | iterator, iterable, get, getter, @@iterator, Symbol.iterator, Symbol.asyncIterator |

## Links

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

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 2.0.1 (latest) — 2023-08-14
- 2.0.0 — 2022-01-12
- 1.0.2 — 2019-02-24
- 1.0.1 — 2018-11-01
- 1.0.0 — 2018-11-01

## README

# get-iterator

[![Build Status](https://github.com/alanshaw/get-iterator/actions/workflows/js-test-and-release.yml/badge.svg?branch=master)](https://github.com/alanshaw/get-iterator/actions/workflows/js-test-and-release.yml)
[![Dependencies Status](https://status.david-dm.org/gh/alanshaw/get-iterator.svg)](https://david-dm.org/alanshaw/get-iterator)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

> Get the default iterator or async iterator for an iterable or async iterable

Reduce the boilerplate of extracting the iterator from an object when you don't know if the object is an (async) iterable or already an (async) iterator.

## Install

```sh
npm install get-iterator
```

## Usage

```js
import { getIterator } from 'get-iterator'
const input = [1, 2, 3]
const it = getIterator(input)
console.log(it.next()) // { done: false, value: 1 }
console.log(it.next()) // { done: false, value: 2 }
console.log(it.next()) // { done: false, value: 3 }
console.log(it.next()) // { done: true, value: undefined }
```

### Examples

Regular iterator from iterable:

```js
import { getIterator } from 'get-iterator'

const input = [1, 2, 3]
const iterable = {
  [Symbol.iterator] () {
    let i = 0
    return {
      next () {
        const value = input[i++]
        return { done: !value, value }
      }
    }
  }
}

const it = getIterator(input)
console.log(it.next()) // { done: false, value: 1 }
console.log(it.next()) // { done: false, value: 2 }
console.log(it.next()) // { done: false, value: 3 }
console.log(it.next()) // { done: true, value: undefined }
```

Async iterator from iterable:

```js
import { getIterator } from 'get-iterator'

const input = [1, 2, 3]
const iterable = {
  [Symbol.asyncIterator] () {
    let i = 0
    return {
      async next () {
        const value = await new Promise((resolve, reject) => {
          setTimeout(() => resolve(input[i++]), 10)
        })
        return { done: !value, value }
      }
    }
  }
}

const it = getIterator(iterable)
console.log(await it.next()) // { done: false, value: 1 }
console.log(await it.next()) // { done: false, value: 2 }
console.log(await it.next()) // { done: false, value: 3 }
console.log(await it.next()) // { done: true, value: undefined }
```

Already an iterator (probably):

```js
import { getIterator } from 'get-iterator'

const input = [1, 2, 3]
let i = 0
const iterator = {
  next () {
    const value = input[i++]
    return { done: !value, value }
  }
}

const it = getIterator(iterator)
console.log(it.next()) // { done: false, value: 1 }
console.log(it.next()) // { done: false, value: 2 }
console.log(it.next()) // { done: false, value: 3 }
console.log(it.next()) // { done: true, value: undefined }
```

## API

```js
import { getIterator } from 'get-iterator'
```

### `getIterator(obj)`

Get the default iterator or async iterator for an Iterable. If `obj` is already an iterator (i.e. has a `next` function) return it, since it's probably already an iterator.

This function will throw if `obj` is not an iterable or iterator.

#### Parameters

| Name | Type | Description |
|------|------|-------------|
| obj | [`Iterable`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterable_protocol)\|[`Iterator`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol) | The object to extract the iterator from (may be an iterator already). |

#### Returns

| Type | Description |
|------|-------------|
| [`Iterator`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#The_iterator_protocol) | The result of calling `obj[Symbol.iterator]()` or `obj[Symbol.asyncIterator]()` or simply the passed `obj` if it is already an iterator. |

## Contribute

Feel free to dive in! [Open an issue](https://github.com/alanshaw/get-iterator/issues/new) or submit PRs.

## License

[MIT](https://github.com/alanshaw/get-iterator/blob/master/LICENSE) © Alan Shaw

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