Config

besom.internal.Config
See theConfig companion class
object Config

Attributes

Companion
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Config.type

Members list

Extensions

Extensions

extension (output: Output[Config])

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Requires ConfigValueReader[A] to be in scope.

Type parameters

A

the type of the configuration value

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

an optional configuration or secret value of the requested type

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

an optional configuration or secret Boolean value

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

an optional configuration or secret Double value

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

an optional configuration or secret Int value

def getJson(key: NonEmptyString)(using Context): Output[Option[JsValue]]

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

an optional configuration or secret besom.json.JsValue value

def getObject[A : JsonReader](key: NonEmptyString)(implicit evidence$11: ConfigValueReader[A], evidence$12: JsonReader[A], Context): Output[Option[A]]

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Requires JsonReader[A] or ConfigValueReader[A] to be in scope.

Type parameters

A

the type to deserialize configuration or secret JSON value into

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

an optional configuration or secret deserialized JSON value of the requested type

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads an optional configuration or secret value by its key, or returns None if it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

an optional configuration or secret String value

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Requires ConfigValueReader[A] to be in scope.

Type parameters

A

the type of the configuration value

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

the configuration or secret value of the requested type or ConfigError

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

the configuration or secret Boolean value or ConfigError

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

the configuration or secret Double value or ConfigError

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

the configuration or secret Int value or ConfigError

def requireJson(key: NonEmptyString)(using Context): Output[JsValue]

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

the configuration or secret besom.json.JsValue value or ConfigError

def requireObject[A : JsonReader](key: NonEmptyString)(implicit evidence$13: ConfigValueReader[A], evidence$14: JsonReader[A], Context): Output[A]

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Requires JsonReader[A] or ConfigValueReader[A] to be in scope.

Type parameters

A

the type to deserialize configuration or secret JSON value into

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

the configuration or secret deserialized JSON value of the requested type or ConfigError

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Loads a configuration or secret value by its key, or Output.fail it doesn't exist. If the configuration value is a secret, it will be marked internally as such and redacted in console outputs.

Value parameters

Context

the Besom context

key

the requested configuration or secret key

Attributes

Returns

the configuration or secret String value or ConfigError