# quickiter

> Fast iterator library

Latest version **0.8.0** (published 2021-03-02) · ISC license · 0 weekly downloads

## Install

```sh
npm install quickiter
pnpm add quickiter
yarn add quickiter
bun add quickiter
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.0 |
| Published | 2021-03-02 |
| First published | 2020-03-03 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 76 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Hajime Yamasaki Vukelic |
| Maintainers | foxbunny |
| Keywords | ierator, iterable, utilities |

## Links

- npm: https://www.npmjs.com/package/quickiter
- Repository: https://github.com/foxbunny/quickiter
- Homepage: https://github.com/foxbunny/quickiter#readme
- Issues: https://github.com/foxbunny/quickiter/issues
- npm.io page: https://npm.io/package/quickiter

## Recent versions

- 0.8.0 (latest) — 2021-03-02
- 0.6.1 — 2021-02-10
- 0.6.0 — 2021-01-25
- 0.5.0 — 2020-07-03
- 0.4.0 — 2020-04-03
- 0.3.0 — 2020-03-31
- 0.2.6 — 2020-03-04
- 0.2.5 — 2020-03-03
- 0.2.4 — 2020-03-03
- 0.2.3 — 2020-03-03
- 0.2.2 — 2020-03-03
- 0.2.1 — 2020-03-03
- 0.2.0 — 2020-03-03

## README

# Quickiter

Fast iterator library.

[![Build Status](https://travis-ci.org/foxbunny/quickiter.svg?branch=master)](https://travis-ci.org/foxbunny/quickiter)

## Overview

This library provides functions and objects for iterating over sequences 
using the [iteration protocol](https://mzl.la/2HACVDf).

See [introduction](./docs/introduction.md) for a more in-depth introduction to
iterators.

## Motivation

Quickiter's functionality similar to several packages on NPM. Unlike most of 
those packages, this library does *not* use the new ES6 generators. Instead 
it uses only the iterator protocol. This yields (pun intended) a significant 
performance improvement while more or less completely retaining the 
functionality of generator based iterators.

## Is this a replacement for generators?

No. Generator functions can do a lot more than create iterators. For example,
they can be used to write coroutines. The scope of this library is strictly 
to work with iterable sequences.

## Installation

To add quickiter package to your project, use the following commands:

```
npm install --save quickiter
```

or

```
yarn add quickiter
```

## Documentation

- [Terminology](docs/terminology.md)
- [Why iterators?](./docs/introduction.md)
- [Iteration functions](./docs/functions.md)
- [Iterable wrapper object](./docs/iter.md)

## Benchmarks

The `benchmarks` folder contains a rudimentary benchmark that is used to 
optimize the library code. Here is a sample of the results as run on a Core 
i7 7700HQ Windows 10 PC and NodeJS 10.15.

```
procedural: 11.29ms (fastest)
single reduce: 12.51ms (+1.22ms / 1.1x slower)
single forEach: 12.92ms (+1.62ms / 1.1x slower)
Iter object: 16.31ms (+5.01ms / 1.4x slower)
iter* composition: 17.10ms (+5.81ms / 1.5x slower)
generators: 28.29ms (+17.00ms / 2.5x slower)
map/filter chain: 40.31ms (+29.02ms / 3.6x slower)
```

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