0b82373111
|
||
|---|---|---|
| .. | ||
| Alt | ||
| Alternative | ||
| Applicative | ||
| Apply | ||
| Array | ||
| Bifunctor | ||
| BooleanAlgebra | ||
| Bounded | ||
| BoundedDistributiveLattice | ||
| BoundedJoinSemilattice | ||
| BoundedLattice | ||
| BoundedMeetSemilattice | ||
| Category | ||
| Chain | ||
| ChainRec | ||
| Choice | ||
| Comonad | ||
| Compactable | ||
| Console | ||
| Const | ||
| Contravariant | ||
| Date | ||
| DistributiveLattice | ||
| Either | ||
| EitherT | ||
| Endomorphism | ||
| Eq | ||
| Extend | ||
| Field | ||
| Filterable | ||
| FilterableWithIndex | ||
| Foldable | ||
| FoldableWithIndex | ||
| FromEither | ||
| FromIO | ||
| FromReader | ||
| FromState | ||
| FromTask | ||
| FromThese | ||
| Functor | ||
| FunctorWithIndex | ||
| Group | ||
| HKT | ||
| HeytingAlgebra | ||
| IO | ||
| IOEither | ||
| IOOption | ||
| IORef | ||
| Identity | ||
| Invariant | ||
| JoinSemilattice | ||
| Json | ||
| Lattice | ||
| Magma | ||
| Map | ||
| MeetSemilattice | ||
| Monad | ||
| MonadIO | ||
| MonadTask | ||
| MonadThrow | ||
| Monoid | ||
| NaturalTransformation | ||
| NonEmptyArray | ||
| Option | ||
| OptionT | ||
| Ord | ||
| Ordering | ||
| Pointed | ||
| Predicate | ||
| Profunctor | ||
| Random | ||
| Reader | ||
| ReaderEither | ||
| ReaderIO | ||
| ReaderT | ||
| ReaderTask | ||
| ReaderTaskEither | ||
| ReadonlyArray | ||
| ReadonlyMap | ||
| ReadonlyNonEmptyArray | ||
| ReadonlyRecord | ||
| ReadonlySet | ||
| ReadonlyTuple | ||
| Record | ||
| Refinement | ||
| Ring | ||
| Semigroup | ||
| Semigroupoid | ||
| Semiring | ||
| Separated | ||
| Set | ||
| Show | ||
| State | ||
| StateReaderTaskEither | ||
| StateT | ||
| Store | ||
| Strong | ||
| Task | ||
| TaskEither | ||
| TaskOption | ||
| TaskThese | ||
| These | ||
| TheseT | ||
| Traced | ||
| Traversable | ||
| TraversableWithIndex | ||
| Tree | ||
| Tuple | ||
| Unfoldable | ||
| ValidationT | ||
| Witherable | ||
| Writer | ||
| WriterT | ||
| Zero | ||
| boolean | ||
| es6 | ||
| function | ||
| internal | ||
| lib | ||
| number | ||
| pipeable | ||
| string | ||
| struct | ||
| void | ||
| CHANGELOG.md | ||
| HKT.d.ts | ||
| LICENSE | ||
| README.md | ||
| package.json | ||
README.md
Functional programming in TypeScript
Introduction
fp-ts is a library for typed functional programming in TypeScript.
fp-ts aims to allow developers to use popular patterns and abstractions that are available in most functional languages. For this, it includes the most popular data types, type classes and abstractions such as Option, Either, IO, Task, Functor, Applicative, Monad to empower users to write pure FP apps and libraries built atop higher order abstractions.
A distinctive feature of fp-ts with respect to other functional libraries is its implementation of Higher Kinded Types, which TypeScript doesn't support natively.
Inspired by
Sponsors
Unsplash https://unsplash.com/
The internet’s source for visuals. |
Installation
To install the stable version:
npm install fp-ts
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).
TypeScript compatibility
Strictness – This library is conceived, tested and is supposed to be consumed by TypeScript with the strict flag turned on.
fp-ts version |
required typescript version |
|---|---|
| 2.0.x+ | 3.5+ |
| 1.15.x+ | 3.1+ |
| <= 1.14.4 | 2.8+ (*) |
(*) If you are running < typescript@3.0.1 you have to polyfill the unknown type. You can use unknown-ts as a polyfill.
Documentation
Disclaimer. Teaching functional programming is out of scope of this project, so the documentation assumes you already know what FP is.
- Docs
- Learning Resources
- Ecosystem
- API Reference
Help
If you need help with fp-ts check out:
- this Discord server
- the
#fp-tschannel on FP slack.
Development
License
The MIT License (MIT)