# async-iterable-fns

> Functions for working with built-in iterable types

Latest version **1.0.0** (published 2020-06-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install async-iterable-fns
pnpm add async-iterable-fns
yarn add async-iterable-fns
bun add async-iterable-fns
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2020-06-09 |
| First published | 2020-06-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=6.0.0 |
| Dependencies | 0 |
| Unpacked size | 463.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Daniel Bradley |
| Maintainers | danielrbradley |
| Keywords | collections, iterable, async-iterable, modules |

## Links

- npm: https://www.npmjs.com/package/async-iterable-fns
- Repository: https://github.com/danielrbradley/async-iterable-fns
- Homepage: https://github.com/danielrbradley/async-iterable-fns#readme
- Issues: https://github.com/danielrbradley/async-iterable-fns/issues
- npm.io page: https://npm.io/package/async-iterable-fns

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 1.0.0 (latest) — 2020-06-09

## README

# Iterable Functions

[![npm version](https://badge.fury.io/js/async-iterable-fns.svg)](https://badge.fury.io/js/async-iterable-fns)
[![GitHub issues](https://img.shields.io/github/issues/danielrbradley/async-iterable-fns.svg)](https://github.com/danielrbradley/async-iterable-fns/issues)
[![TypeDoc docs](https://img.shields.io/badge/TypeDoc-docs-lightgrey.svg)](https://www.danielbradley.net/async-iterable-fns/)
[![Travis](https://img.shields.io/travis/danielrbradley/async-iterable-fns.svg)](https://travis-ci.org/danielrbradley/async-iterable-fns)
[![Coveralls](https://img.shields.io/coveralls/danielrbradley/async-iterable-fns.svg)](https://coveralls.io/github/danielrbradley/async-iterable-fns)
[![Dev Dependencies](https://david-dm.org/danielrbradley/async-iterable-fns/dev-status.svg)](https://david-dm.org/danielrbradley/async-iterable-fns?type=dev)
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

Really simple functions for working with async iterable types, inspired by F#'s collection modules design.

## Features

- Full type-safety with TypeScript
- Zero dependency
- Pure functions

## Installation

Add package using NPM or yarn

```bash
npm i --save async-iterable-fns
```

```bash
yarn add async-iterable-fns
```

You can import the top level modules directly:

```javascript
import { groupBy } from 'async-iterable-fns'
```

## Examples

Calculating primes lazily with iterators can either be done by calling each of the basic functions:

```javascript
import { count, initRaw, map, filter } from 'async-iterable-fns'

const findPrimes = async () => {
  const range = initRaw({ from: 1, to: 100 })
  const mapped = map(range, (x) => ({
    x,
    factors: filter(initRaw({ from: 1, to: x }), (y) => x % y === 0),
  }))
  const filtered = filter(mapped, async (num) => (await count(num.factors)) === 2)
  const primes = map(filtered, (num) => num.x)
  return await toArray(primes)
}
```

or can utilise the chainable methods:

```javascript
import { init } from 'async-iterable-fns'

const findPrimesChained = async () => {
  const primes = init({ from: 1, to: 100 })
    .map((x) => ({
      x,
      factors: init({ from: 1, to: x }).filter((y) => x % y === 0),
    }))
    .filter(async (num) => (await num.factors.count()) === 2)
    .map((num) => num.x)

  for await (const prime of primes) {
    console.log(prime)
  }
}
```

## NPM scripts

- `yarn test`: Run test suite
- `yarn start`: Run `yarn build` in watch mode
- `yarn test:watch`: Run test suite in [interactive watch mode](http://facebook.github.io/jest/docs/cli.html#watch)
- `yarn test:prod`: Run linting and generate coverage
- `yarn build`: Generate bundles and typings, create docs
- `yarn lint`: Lints code
- `yarn commit`: Commit using conventional commit style ([husky](https://github.com/typicode/husky) will tell you to use it if you haven't :wink:)

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