mouse

# Mouse ![Continuous Integration](https://github.com/typelevel/mouse/workflows/Continuous%20Integration/badge.svg) [![Maven Central](https://img.shields.io/maven-central/v/org.typelevel/mouse_2.13)](https://central.sonatype.com/artifact/org.typelevel/mouse_2.13) <a href="https://typelevel.org/cats/"><img src="https://typelevel.org/cats/img/cats-badge.svg" height="40px" align="right" alt="Cats friendly" /></a>

Mouse is a small companion to the [Cats](https://github.com/typelevel/cats) functional programming library and the Scala standard library.

The library arose from this [Cats issue](https://github.com/typelevel/cats/issues/791) and is a [Typelevel member](http://typelevel.org/projects/).

Mouse is published for Scala 2.12, 2.13 and 3.0. For Scala.jvm:

`"org.typelevel" %% "mouse" % version`

For scala.js 1.x:

`"org.typelevel" %%% "mouse" % version`

Learn more about Mouse at https://typelevel.org/mouse/.

## Content

Mouse includes enrichments for:

- [Any](./shared/src/main/scala/mouse/any.scala)
- [Boolean](./shared/src/main/scala/mouse/boolean.scala)
- [Double](./shared/src/main/scala/mouse/double.scala)
- [F\[A\] for any F, A](./shared/src/main/scala/mouse/anyf.scala)
- [F\[Either\[A, B\]\]](./shared/src/main/scala/mouse/feither.scala)
- [F\[Option\[A\]\]](./shared/src/main/scala/mouse/foption.scala)
- [F\[G\[A\]\]](./shared/src/main/scala/mouse/fnested.scala)
- [F\[G\[H\[A\]\]\]](./shared/src/main/scala/mouse/fnested.scala)
- [F\[TupleN\]](./shared/src/main/scala/mouse/ftuple.scala)
- [Int](./shared/src/main/scala/mouse/int.scala)
- [List](./shared/src/main/scala/mouse/list.scala)
- [Long](./shared/src/main/scala/mouse/long.scala)
- [Map](./shared/src/main/scala/mouse/map.scala)
- [Option](./shared/src/main/scala/mouse/option.scala)
- [Set](./shared/src/main/scala/mouse/set.scala)
- [String](./shared/src/main/scala/mouse/string.scala)
- [Try](./shared/src/main/scala/mouse/try.scala)
- [Tuple](./shared/src/main/scala-2/src/main/scala/mouse/tuple.scala)

#### Example:

```scala
scala> import mouse.all._
import mouse.all._

scala> true.option("Its true!")
res0: Option[String] = Some(Its true!)

scala> def makeEven(i: Int) = (i % 2 == 1).applyIf(i)(_ - 1)
def makeEven(i: Int): Int

scala> val e1: Either[String, Int] = Left("failed")
e1: Either[String,Int] = Left(failed)

scala> true.whenA(e1)
res0: Either[String,Unit] = Left(failed)

scala> false.whenA(e1)
res1: Either[String,Unit] = Right(())

scala> res0.cata(msg => s"Message received: ${msg}", "No message")
res1: String = Message received: Its true!

scala> "1.0".parseFloat
res0: Either[NumberFormatException, Float] = Right(1.0F)

scala> "foo".parseIntValidated
res1: cats.data.Validated[NumberFormatException,Int] = Invalid(java.lang.NumberFormatException: For input string: "foo")

scala> val t1 = scala.util.Try(new java.net.URL("https://www.github.com"))
t1: scala.util.Try[java.net.URL] = Success(https://www.github.com)

scala> t1.cata(msg => s"URL is valid!", error => s"URL is invalid: