fp-ts-iterable
v4.2.6
Published
fp-ts bindings for `Iterable` types, allowing for programming lazy and infinite lists.
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-iterableDocumentation
Please visit the documentation for the API surface.
Upcoming
- Structures
IterableTaskfor interop withAsyncIteratorNonemptyIterableNonempyIterableTask
Recommendations
Coersion from types that are Iterable
- If coersing from something like a
ReadonlyArray, it's recommended to coerce it to anIterableusingFromReadonlyArray. - There is no performance benefit, but it could alleviate bugs before they happen.
\*Right* functions
- All functions using the word
Rightin their names require buffering all values so it knows where the end is. - If the
Iterableis 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
