ConfigKey

object ConfigKey
Companion:
class
class Object
trait Matchable
class Any

Value members

Concrete methods

final def apply(description: => String): ConfigKey

Returns a new ConfigKey with the specified description.

Returns a new ConfigKey with the specified description.

final def env(name: String): ConfigKey

Returns a new ConfigKey for the specified environment variable.

Returns a new ConfigKey for the specified environment variable.

Example:
scala> val apiKey = ConfigKey.env("API_KEY")
apiKey: ConfigKey = ConfigKey(environment variable API_KEY)
scala> apiKey.description
res0: String = environment variable API_KEY
final def prop(name: String): ConfigKey

Returns a new ConfigKey for the specified system property.

Returns a new ConfigKey for the specified system property.

Example:
scala> val apiKey = ConfigKey.prop("api.key")
apiKey: ConfigKey = ConfigKey(system property api.key)
scala> apiKey.description
res0: String = system property api.key
final def unapply(key: ConfigKey): Some[String]

Returns the description for the specified ConfigKey.

Returns the description for the specified ConfigKey.

This function enables pattern matching on ConfigKeys.

Example:
scala> val apiKey = ConfigKey.env("API_KEY")
apiKey: ConfigKey = ConfigKey(environment variable API_KEY)
scala> apiKey match { case ConfigKey(description) => description }
res0: String = environment variable API_KEY

Implicits

Implicits

final implicit val configKeyEq: Eq[ConfigKey]
final implicit val configKeyShow: Show[ConfigKey]