Code Monkey home page Code Monkey logo

sealed-monad's Issues

Improve documentation

The project is currently undocumented - adding descriptions, tips and example (typechecked) usages to functions exposed to the user will be extremely helpful.

Add effectful version of `ensure`

We could use an alternative to this function, preferably named ensureF:

def ensure[ADT](pred: A => Boolean, orElse: => ADT): Sealed[F, A, ADT]     = seal[ADT].ensure(pred, orElse)

This could cut off some boilerplate compared to the following usage of attemptF:

private def setFailed(obj: SomeObj): F[Result] = ???

private def ensureSomething(obj: SomeObj): StepF[Unit] =
    transactor
      .execute(someDbCall())
      .attemptF[Result, Unit] {
        case list if !list.exists(_.id != obj.id) => F.pure(Right(()))
        case _ =>
          setFailed(obj)
            .map(result => Left(result))
      }

versus potential ensureF:

private def ensureSomething(obj: SomeObj): StepF[Unit] =
    transactor
      .execute(someDbCall())
      .ensureF(!_.exists(_.id != deployment.id), setFailed(obj))

`attemptF` - inconsistent type parameter order

Hi,

I have encountered an inconsistency with the order of type parameters in the attemptF method within which could potentially cause confusion.

final class SealedFAOps {
  def attemptF[ADT, B]
}

// When using attemptF:
attemptF[FooResult, Unit]

sealed trait Sealed {
  def attemptF[B, ADT1 >: ADT]
}

// When using attemptF:
attemptF[Unit, FooResult]

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.