Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/foxbunny/quickiter
Fast iterator library
https://github.com/foxbunny/quickiter
es6 es6-iterators iteration iteration-protocol javascript javascript-library
Last synced: 28 days ago
JSON representation
Fast iterator library
- Host: GitHub
- URL: https://github.com/foxbunny/quickiter
- Owner: foxbunny
- License: isc
- Created: 2019-01-31T00:30:31.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T06:43:35.000Z (almost 2 years ago)
- Last Synced: 2024-04-26T09:03:15.919Z (8 months ago)
- Topics: es6, es6-iterators, iteration, iteration-protocol, javascript, javascript-library
- Language: JavaScript
- Size: 1.26 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Quickiter
Fast iterator library.
[](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)
```