https://github.com/makiftutuncu/effect

A basic, home-made functional effect system with powerful errors
https://github.com/makiftutuncu/effect

error-handling functional-effects functional-programming scala

Last synced: 2 months ago
JSON representation

A basic, home-made functional effect system with powerful errors

• Host: GitHub
• URL: https://github.com/makiftutuncu/effect
• Owner: makiftutuncu
• License: mit
• Created: 2022-05-09T09:24:26.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-28T10:47:40.000Z (2 months ago)
• Last Synced: 2024-10-28T14:06:10.159Z (2 months ago)
• Topics: error-handling, functional-effects, functional-programming, scala
• Language: Scala
• Homepage:
• Size: 92.8 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Effect [![](https://img.shields.io/badge/docs-0.3.1-brightgreen.svg?style=for-the-badge&logo=scala&color=dc322f&labelColor=333333)](https://javadoc.io/doc/dev.akif/effect-core_3)

## Table of Contents

1. [Introduction](#introduction)

2. [Installation](#installation)

3. [Development and Testing](#development-and-testing)

4. [Contributing](#contributing)

5. [License](#license)

## Introduction

Effect is a basic, home-made functional effect system with powerful errors.

A value of type `Effect[A]` is a description of a computation that can produce a value of type `A`, can fail with an error `E`, can fail unexpectedly with a `Throwable` or can be interrupted.

Effect has only one type parameter. `Effect[A]` is mentally equivalent to `ZIO[Any, E, A]` where error type `E` is fixed to the error model [`e.scala.E`](https://github.com/makiftutuncu/e/tree/master/e-scala#1-e).

Effect is **only a functional effect and not a complete solution to everything**.

## Installation

Add following to your `build.sbt` (for now, Scala 3 only):

```scala

libraryDependencies += "dev.akif" %% "effect-core" % "0.3.1"

```

## Development and Testing

Effect is built with SBT. So, standard SBT tasks like `clean`, `compile` and `test` can be used.

To run all tests:

```shell

sbt test

```

To run specific test(s):

```shell

sbt 'testOnly fullyQualifiedTestClassName1 fullyQualifiedTestClassName2 ...'

```

## Contributing

All contributions are welcome. Please feel free to send a pull request. You may check [project page](https://github.com/users/makiftutuncu/projects/1) for current status of development and issues. Thank you!

## License

Effect is licensed with [MIT License](LICENSE.md).