ConfigKey

ciris.ConfigKey

See theConfigKey companion class

object ConfigKey

Attributes

Companion: class
Graph
Supertypes: class Object

trait Matchable

class Any
Self type: ConfigKey.type

Members list

Value members

Concrete methods

Returns a new ConfigKey with the specified description.

Attributes

Returns a new ConfigKey for the specified environment variable.

Attributes

Example

scala> val apiKey = ConfigKey.env("API_KEY")
apiKey: ConfigKey = ConfigKey(environment variable API_KEY)
scala> apiKey.description
res0: String = environment variable API_KEY

Returns a new ConfigKey for the specified system property.

Attributes

Example

scala> val apiKey = ConfigKey.prop("api.key")
apiKey: ConfigKey = ConfigKey(system property api.key)
scala> apiKey.description
res0: String = system property api.key

Returns the description for the specified ConfigKey.

This function enables pattern matching on ConfigKeys.

Attributes

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

Attributes

In this article

Generated with