README.md
:roll_of_paper: [@iterable-iterator/iter](https://iterable-iterator.github.io/iter)
==
An `iter` function for JavaScript.
See [docs](https://iterable-iterator.github.io/iter/index.html).
> :warning: Depending on your environment, the code may require
> `regeneratorRuntime` to be defined, for instance by importing
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
```js
import {iter} from '@iterable-iterator/iter';
iter('ABC').next().value; // A
```
[![License](https://img.shields.io/github/license/iterable-iterator/iter.svg)](https://raw.githubusercontent.com/iterable-iterator/iter/main/LICENSE)
[![Version](https://img.shields.io/npm/v/@iterable-iterator/iter.svg)](https://www.npmjs.org/package/@iterable-iterator/iter)
[![Tests](https://img.shields.io/github/actions/workflow/status/iterable-iterator/iter/ci.yml?branch=main&event=push&label=tests)](https://github.com/iterable-iterator/iter/actions/workflows/ci.yml?query=branch:main)
[![Dependencies](https://img.shields.io/librariesio/github/iterable-iterator/iter.svg)](https://github.com/iterable-iterator/iter/network/dependencies)
[![GitHub issues](https://img.shields.io/github/issues/iterable-iterator/iter.svg)](https://github.com/iterable-iterator/iter/issues)
[![Downloads](https://img.shields.io/npm/dm/@iterable-iterator/iter.svg)](https://www.npmjs.org/package/@iterable-iterator/iter)
[![Code issues](https://img.shields.io/codeclimate/issues/iterable-iterator/iter.svg)](https://codeclimate.com/github/iterable-iterator/iter/issues)
[![Code maintainability](https://img.shields.io/codeclimate/maintainability/iterable-iterator/iter.svg)](https://codeclimate.com/github/iterable-iterator/iter/trends/churn)
[![Code coverage (cov)](https://img.shields.io/codecov/c/gh/iterable-iterator/iter/main.svg)](https://codecov.io/gh/iterable-iterator/iter)
[![Code technical debt](https://img.shields.io/codeclimate/tech-debt/iterable-iterator/iter.svg)](https://codeclimate.com/github/iterable-iterator/iter/trends/technical_debt)
[![Documentation](https://iterable-iterator.github.io/iter/badge.svg)](https://iterable-iterator.github.io/iter/source.html)
[![Package size](https://img.shields.io/bundlephobia/minzip/@iterable-iterator/iter)](https://bundlephobia.com/result?p=@iterable-iterator/iter)