# @cuties/iterator

> Cutie extension for the iterable protocol in JavaScript.

Latest version **1.1.3** (published 2019-05-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @cuties/iterator
pnpm add @cuties/iterator
yarn add @cuties/iterator
bun add @cuties/iterator
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2019-05-10 |
| First published | 2018-08-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | guseyn |
| Maintainers | guseyn |
| Keywords | cutie, iterator, iterable |

## Links

- npm: https://www.npmjs.com/package/@cuties/iterator
- Repository: https://github.com/Guseyn/cutie-iterator
- Homepage: https://github.com/Guseyn/cutie-iterator#readme
- Issues: https://github.com/Guseyn/cutie-iterator/issues
- npm.io page: https://npm.io/package/@cuties/iterator

## Dependencies (5)

- [@cuties/is](https://npm.io/package/@cuties/is.md) ^1.1.2
- [@cuties/wall](https://npm.io/package/@cuties/wall.md) ^1.1.2
- [@cuties/cutie](https://npm.io/package/@cuties/cutie.md) ^1.7.5
- [test-executor](https://npm.io/package/test-executor.md) ^1.2.2
- [@cuties/assert](https://npm.io/package/@cuties/assert.md) ^1.2.2

## Recent versions

- 1.1.3 (latest) — 2019-05-10
- 1.1.2 — 2019-05-10
- 1.1.1 — 2019-05-10
- 1.1.0 — 2019-02-21
- 1.0.8 — 2019-02-17
- 1.0.7 — 2019-02-17
- 1.0.6 — 2019-02-16
- 1.0.5 — 2018-09-22
- 1.0.4 — 2018-08-28

## README

# cutie-iterator

[![NPM Version](https://img.shields.io/npm/v/@cuties/iterator.svg)](https://npmjs.org/package/@cuties/iterator)
[![Build Status](https://travis-ci.org/Guseyn/cutie-iterator.svg?branch=master)](https://travis-ci.org/Guseyn/cutie-iterator)
[![codecov](https://codecov.io/gh/Guseyn/cutie-iterator/branch/master/graph/badge.svg)](https://codecov.io/gh/Guseyn/cutie-iterator)

[Cutie](https://github.com/Guseyn/cutie) extension for work with </b>iterable protocol</b> in JavaScript. It's based on the [Async Tree Pattern](https://github.com/Guseyn/async-tree-patern/blob/master/Async_Tree_Patern.pdf).

## Examples

You can find examples of using this library in the [test directory](https://github.com/Guseyn/cutie-iterator/tree/master/test).

## Install

`npm install @cuties/iterator`

## Run test

`npm test`

## Run build

`npm run build`

## Usage

```js
const {
  // Needed async objects here from the table below
} = require('@cuties/iterator');
```
For more information about parameters in the async objects visit [MDN docs for Iterable](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).

| Async Object | Async/sync call | Parameters(default value/description) | Representation result |
| ------------- | ----------------| ---------- | --------------------- |
| `IteratorProtocol` | `iterator[Symbol.iterator]` | `iterator` | `object` |
| `Next` | `iterator.next` | `iterator.next` | `object` |

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