configs

A Scala wrapper for Typesafe config

Usage

build.sbt

libraryDependencies += "com.github.kxbmap" %% "configs" % "0.2.3"

Imports

import com.github.kxbmap.configs._

Examples

import com.typesafe.config.ConfigFactory

val config = ConfigFactory.load()

Standard values

val a = config.get[Int]("a")          // == config.getInt("a")
val b = config.get[String]("b")       // == config.getString("b")
vsl c = config.get[List[Double]]("c") // Returns scala.List[Double], NOT java.util.List[java.lang.Double]

Bytes

Use com.github.kxbmap.configs.Bytes

val Bytes(bytes) = config.get[Bytes]("bs") // bytes == config.getBytes("bs").longValue()

Map

val m = config.get[Map[String, Int]]("m")

Duration

import scala.concurrent.duration.Duration
val d = config.get[Duration]("d")

Option

val s = config.get[Option[String]]("string")  // == Some("something")
val t = config.opt[String]("string")          // alias

By default, get[Option[T]] handles only ConfigException.Missing

// read missing value
val m = config.opt[String]("missing")  // == None

// read wrong type value
val n = config.opt[Int]("string")  // Exception! throws ConfigException.WrongType

Import implicit CatchCond (alias for Throwable => Boolean) value, change this behavior

import CatchCond.configException

// read wrong type value
val n = config.opt[Int]("string")  // == None

Either

val r = config.get[Eihter[Throwable, String]]("string")  // == Right("something")
val l = config.get[Either[Throwable, Int]]("string")     // == Left(ConfigException.WrongType(...))

Try

val s = config.get[Try[String]]("string")  // == Success("something")
val f = config.get[Try[Int]]("string")     // == Failure(ConfigException.WrongType(...))

License

Apache License, Version 2.0

plm/configs