An open API service indexing awesome lists of open source software.

https://github.com/velocityzen/fp-ts-iterators

Functional Iterable and AsyncIterable
https://github.com/velocityzen/fp-ts-iterators

async-iterable async-iterator fp-ts iterable iterator stream

Last synced: about 1 year ago
JSON representation

Functional Iterable and AsyncIterable

Awesome Lists containing this project

README

          

# AsyncIterable and Iterable with fp-ts

[![NPM Version](https://img.shields.io/npm/v/fp-ts-iterators.svg?style=flat-square)](https://www.npmjs.com/package/fp-ts-iterators)
[![NPM Downloads](https://img.shields.io/npm/dt/fp-ts-iterators.svg?style=flat-square)](https://www.npmjs.com/package/fp-ts-iterators)

## Installation

To install the stable version:

```
npm install fp-ts fp-ts-iterators
```

`fp-ts` is a peer dependency. Make sure to always have a single version of `fp-ts` installed in your project. Multiple versions are known to cause `tsc` to hang during compilation. You can check the versions currently installed using `npm ls fp-ts` (make sure there's a single version and all the others are marked as `deduped`).

# Documentation

**Disclaimer**. Teaching functional programming is out of scope of this project, so the documentation assumes you already know what FP is.

- [docs](https://velocityzen.github.io/fp-ts-iterators/)
- [fp-ts docs](https://gcanti.github.io/fp-ts)
- [ecosystem](https://gcanti.github.io/fp-ts/ecosystem/)

# License

The MIT License (MIT)