cats-time

Build Status Maven Central

Instances for Cats Typeclasses for Java 8 Time. Similar to the encoding that are offered in Circe and Cormorant.

Time is a pain to deal with reasonably. So tread with caution.

Quick Start

To use cats-time in an existing SBT project with Scala 2.11 or a later version, add the following dependencies to your build.sbt depending on your needs:

libraryDependencies ++= Seq(
  "org.typelevel" %% "cats-time"     % "0.5.1"
)

Examples

First lets start with some imports.

import org.typelevel.cats.time._
import cats.syntax.all._
import java.time._

Then we can display the Show instances.

DayOfWeek.MONDAY.show
// res0: String = "Monday"

Duration.ofDays(3).show
// res1: String = "PT72H"

Instant.now.show
// res2: String = "2023-09-27T17:54:51.144Z"

LocalDate.now.show
// res3: String = "2023-09-27"

LocalDateTime.now.show
// res4: String = "2023-09-27T17:54:51.145"

LocalTime.now.show
// res5: String = "17:54:51.146"

MonthDay.now.show
// res6: String = "9-27"

OffsetDateTime.now.show
// res7: String = "2023-09-27T17:54:51.147Z"

OffsetTime.now.show
// res8: String = "17:54:51.148Z"

Period.ofWeeks(6).show
// res9: String = "P42D"

Year.now.show
// res10: String = "2023"

YearMonth.now.show
// res11: String = "2023-09"

ZoneId.systemDefault.show
// res12: String = "Etc/UTC"

ZonedDateTime.now.show
// res13: String = "2023-09-27T17:54:51.15Z[Etc/UTC]"