# iter-util

> Simply work with iterables

Latest version **0.3.1** (published 2020-11-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install iter-util
pnpm add iter-util
yarn add iter-util
bun add iter-util
```

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.1 |
| Published | 2020-11-17 |
| First published | 2020-11-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 325.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Yuhsak Inoue |
| Maintainers | yuhsak |

## Links

- npm: https://www.npmjs.com/package/iter-util
- Repository: https://github.com/Yuhsak/iter-util
- Homepage: https://github.com/Yuhsak/iter-util#readme
- Issues: https://github.com/Yuhsak/iter-util/issues
- npm.io page: https://npm.io/package/iter-util

## Recent versions

- 0.3.1 (latest) — 2020-11-17
- 0.3.0 — 2020-11-16
- 0.2.4 — 2020-11-15
- 0.2.3 — 2020-11-13
- 0.2.2 — 2020-11-12
- 0.2.1 — 2020-11-12
- 0.2.0 — 2020-11-12

## README

# iter-util

## Install

```sh
npm install iter-util
```

## Basic Usage

```ts
import {flat, flatMap, map, filter, slice, concat, reduce, returnValue} from 'iter-util'

function* gen() {
  yield [10, 11, 12]
  yield [13, 14, 15]
  yield [16, 17, 18]
}

// Generator<[10, 11, 12, 13, 14, 15, 16, 17, 18]>
const flatGen = flat(gen())

// Generator<[1, 0, 1, 1, 1, 2, 1, 3, 1, 4, 1, 5, 1, 6, 1, 7, 1, 8]>
const flatMapGen = flatMap(flatGen, v => String(v).split('').map(Number))

// Generator<[3, 0, 3, 3, 3, 6, 3, 9, 3, 12, 3, 15, 3, 18, 3, 21, 3, 24]>
const mapGen = map(flatMapGen, v => v * 3)

// Generator<[0, 6, 12, 18, 24]>
const filterGen = filter(mapGen, v % 2 === 0)

// Generator<[0, 1, 2, 0, 6, 12, 18, 24, 3, 4, 5]>
const concatGen = concat(
  [0, 1, 2],
  filterGen,
  [3, 4, 5]
)

// Generator<[1, 2, 0, 6, 12, 18, 24, 3]>
const sliceGen = slice(concatGen, 1, 9)

// Generator<[3, 3, 9, 21, 39, 63, 66]>
const reduceGen = reduce(sliceGen, (a, b) => a + b)

// 66
console.log(returnValue(reduceGen))
```

## Product, Permutation, Combination

```ts
import {product, permutation, combination} from 'iter-util/product'

// Generator<[0, 0], [0, 1], [0, 2], [1, 0], [1, 1], [1, 2], [2, 0], [2, 1], [2, 2]>
const prod2 = product([0, 1, 2], [0, 1, 2])

// Generator<[0, 0, 0], [0, 0, 1], [0, 0, 2], [0, 1, 0], [0, 1, 1], [0, 1, 2], [0, 2, 0], [0, 2, 1], [0, 2, 2], [1, 0, 0]...>
const prod3 = product([0, 1, 2], [0, 1, 2], [0, 1, 2])

// Generator<[0, 1], [0, 2], [1, 0], [1, 2], [2, 0], [2, 1]>
const perm2 = permutation([0, 1, 2], [0, 1, 2])

// Generator<[0, 1, 2], [0, 2, 1], [1, 0, 2], [1, 2, 0], [2, 0, 1], [2, 1, 0]>
const perm3 = permutation([0, 1, 2], [0, 1, 2], [0, 1, 2])

// Generator<[0, 1], [0, 2], [1, 2]>
const comb2 = combination([0, 1, 2], [0, 1, 2])

// Generator<[0, 1, 2]>
const comb3 = combination([0, 1, 2], [0, 1, 2], [0, 1, 2])
```

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