Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pavelannin/monadic-kotlin
Monadic is a distributed multiplatform Kotlin framework that provides a way to write code from functional programming
https://github.com/pavelannin/monadic-kotlin
either functional-programming kotlin monad multiplatform
Last synced: 2 days ago
JSON representation
Monadic is a distributed multiplatform Kotlin framework that provides a way to write code from functional programming
- Host: GitHub
- URL: https://github.com/pavelannin/monadic-kotlin
- Owner: pavelannin
- License: apache-2.0
- Created: 2024-04-05T07:41:21.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-11-08T05:14:37.000Z (7 days ago)
- Last Synced: 2024-11-08T06:18:21.401Z (7 days ago)
- Topics: either, functional-programming, kotlin, monad, multiplatform
- Language: Kotlin
- Homepage:
- Size: 146 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
EN | [RU](README-RU.md)
[](https://opensource.org/licenses/Apache-2.0)
# Overview
## What is Monadic
Monadic is a distributed Kotlin multiplatform library that provides the ability to use functional programming in Kotlin.
### What is distributed framework
Monadic allows you to include in dependencies only the part that you plan to use in the project.
Developers often do not add large functional libraries to their projects due to excessive workload,
increasing the size of the application and the possibility for other developers to use the unwanted part of the library.
Monadic solves this problem - connect only those parts of the library that you plan to use.
# How to use
## Using the BOM
The `BOM` specification allows you to manage all versions of the Monadic library by specifying only the version of the specification.
The specification itself contains links to versions of various Monadic libraries. When using the specification in your application ,
you do not need to add any version of the Monadic library dependency. When you update a version of the specification,
all the libraries you use are automatically updated to the new versions.
It is recommended to use the `BOM` specification if you use more than one part of the Monadic library.
```gradle
implementation(platform("io.github.pavelannin:monadic-bom:"))
```
## Either
The `Either` monad is a functional construct used to handle alternative results or errors.
Typed errors refer to a functional programming technique in which potential errors
that may occur during the execution of an operation are explicitly described in the signature.
```gradle
implementation("io.github.pavelannin:monadic-either-core")
```
## Utility functions
Utilities for functions in a functional style: composition, currying, etc.
```gradle
implementation("io.github.pavelannin:monadic-function-core")
```
## LCE
The `LCE` monad is a functional construct used to handle the state of operations (consisting of 3 states: execution,
successful and error).
Convenient use for determining the state of the screen or an operation on a user view
(used in MVI approaches).
```gradle
implementation("io.github.pavelannin:monadic-lce-core")
```
### LCE - Either (Extensions)
A set of utilities that extend the capabilities of `LCE` and `Either'.
```gradle
implementation("io.github.pavelannin:monadic-lce-either")
```
## Optional
The `Optinal` monad is a functional construct used for a value that can be `null'.
```gradle
implementation("io.github.pavelannin:monadic-optional-core")
```
### Optional - Either (Extensions)
A set of utilities that extend the capabilities of `Optional` and `Either'.
```gradle
implementation("io.github.pavelannin:monadic-optional-either")
```