Functional programming in Dart and Flutter. All the main functional programming types and patterns fully documented, tested, and with examples.
Fpdart is fully documented. You do not need to have any previous experience with functional programming to start using
fpdart. Give it a try!
Note: The package is still in early development. The API may change frequently and there will be many breaking changes. The documentation and testing is currently under development, but it is coming soon and fast. Follow my Twitter for daily updates.
# pubspec.yaml dependencies: fpdart: ^0.0.3 # Check out the latest version
/// Create an instance of [Some] final option = Option.of(10); /// Create an instance of [None] final none = Option<int>.none(); /// Map [int] to [String] final map = option.map((a) => '$a'); /// Extract the value from [Option] final value = option.getOrElse(() => -1); /// Pattern matching final match = option.match( (a) => print('Some($a)'), () => print('None'), ); /// Convert to [Either] final either = option.toEither(() => 'missing'); /// Chain computations final flatMap = option.flatMap((a) => Option.of(a + 10)); /// Return [None] if the function throws an error final tryCatch = Option.tryCatch(() => int.parse('invalid'));
/// Create an instance of [Right] final right = Either<String, int>.of(10); /// Create an instance of [Left] final left = Either<String, int>.left('none'); /// Map the right value to a [String] final mapRight = right.map((a) => '$a'); /// Map the left value to a [int] final mapLeft = right.mapLeft((a) => a.length); /// Return [Left] if the function throws an error. /// Otherwise return [Right]. final tryCatch = Either.tryCatch( () => int.parse('invalid'), (e, s) => 'Error: $e', ); /// Extract the value from [Either] final value = right.getOrElse((l) => -1); /// Chain computations final flatMap = right.flatMap((a) => Either.of(a + 10)); /// Pattern matching final match = right.match( (l) => print('Left($l)'), (r) => print('Right($r)'), ); /// Convert to [Option] final option = right.toOption();
Functional programming is becoming more and more popular, and for good reasons.
Many non-functional languages are slowly adopting patterns from functional languages, dart included. Dart already supports higher-order functions, generic types, type inference. Other functional programming features are coming to the language, like pattern matching, destructuring, multiple return values, higher-order types.
Many packages are bringing functional patterns to dart, like the amazing freezed for unions/pattern matching.
Fpdart aims to provide all the main types found in functional languages to dart. Types like
Option (handle missing values without
Either (handle errors and error messages),
Task (composable async computations), and more.
Differently from many other functional programming packages,
fpdart aims to introduce functional programming to every developer. For this reason, every type and method is commented and documented directly in the code.
You do not need to have any previous experience with functional programming to start using
One of the major pain points of dartz has always been is lack of documentation. This is a huge issue for people new to functional programming to attempt using the package.
dartz was released in 2016, initially targeting Dart 1.
dartz is also missing some features and types (
TaskEither, and others).
Fpdart is a rewrite based on fp-ts and cats. The main differences are:
- Fpdart is fully documented.
- Fpdart implements higher-kinded types using defunctionalization.
- Fpdart is based on Dart 2.
- Fpdart is completely null-safe from the beginning.
- Fpdart has a richer API.
- Fpdart implements some missing types in dartz.
- Fpdart (currently) does not provide implementation for immutable collections (
The long-term goal is to provide all the main types and typeclasses available in other functional programming languages and packages. All the types should be completely documented and fully tested.
A well explained documentation is the key for the long-term success of the project. Any article, blog post, or contribution is welcome.
In general, any contribution or feedback is welcome (and encouraged!).
- v0.0.3 - 13 June 2021
- v0.0.2 - 13 June 2021
- v0.0.1 - 28 May 2021
Currently the best way to support me would be to follow me on my Twitter.
Another option (or
Option) would be to buy me a coffee.
MIT License, see the LICENSE.md file for details.