Functional programming in TypeScript

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

• Haskell
• PureScript
• Scala

Table of contents

• Installation
  • Consuming fp-ts
  • TypeScript compatibility
• Documentation
• Development
• License

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).

Most examples will use the following import syntax:

import { Option, some, none } from 'fp-ts/lib/Option'

This will give you the widest support across tools, as you will be importing CommonJS modules.

If you use a bundler such as webpack or Rollup that supports tree-shaking, you can take advantage of this by opting to import ECMAScript modules instead:

import { Option, some, none } from 'fp-ts/es6/Option'

Note that there are caveats such as some tools (e.g. Jest) not supporting ES6 module syntax natively yet.

Strictness – This library is conceived, tested and is supposed to be consumed by TypeScript with the strict flag turned on.

(*) If you are running < [email protected] you have to polyfill the unknown type. You can use unknown-ts as a polyfill.

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
  • version 2.x (current)
  • version 1.x

• Code conventions

The MIT License (MIT)