fp-ts-iterable
v4.2.6
Published
fp-ts bindings for `Iterable` types, allowing for programming lazy and infinite lists.
Downloads
2
Readme
fp-ts-iterable
fp-ts bindings for Iterable
types, allowing for programming lazy and infinite lists.
This could (soon) be used as a drop in replacement for the module fp-ts/ReadonlyArray
Installation
# npm
npm install fp-ts-iterable
# yarn
yarn add fp-ts-iterable
# pnpm
pnpm add fp-ts-iterable
Documentation
Please visit the documentation for the API surface.
Upcoming
- Structures
IterableTask
for interop withAsyncIterator
NonemptyIterable
NonempyIterableTask
Recommendations
Coersion from types that are Iterable
- If coersing from something like a
ReadonlyArray
, it's recommended to coerce it to anIterable
usingFromReadonlyArray
. - There is no performance benefit, but it could alleviate bugs before they happen.
\*Right*
functions
- All functions using the word
Right
in their names require buffering all values so it knows where the end is. - If the
Iterable
is large or infinite, it may cause an out of memory error. Ensure infinite iterables end by using a skip combinator that does not contain the wordRight
.
AsyncIterable
(Upcoming)
AsyncIterable<A>
isIterable<Promise<A>>
, but should be coerced toIterable<Task<A>>
viaFromAsyncIterable