Package-level declarations

Types

data class Deployment @JvmOverloads constructor(val name: String, val isProduction: Boolean = false, val isStaging: Boolean = false, val isTest: Boolean = false, val isLocalDevelopment: Boolean = false)

Deployment describes the context in which the application is running

DeploymentLocation

interface DeploymentLocation

For information about the deployment location.

EnvironmentVariableDeploymentLocation

class EnvironmentVariableDeploymentLocation @JvmOverloads constructor(environmentVariableName: String, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real) : DeploymentLocation

Provides a deployment location id from the environment variable value.

EnvironmentVariableLoader

interface EnvironmentVariableLoader

Loads an environment variable value.

RealEnvironmentVariableLoader

class RealEnvironmentVariableLoader : EnvironmentVariableLoader

Properties

deployments

val deployments: Map<String, Deployment>

DEVELOPMENT

val DEVELOPMENT: Deployment

PRODUCTION

val PRODUCTION: Deployment

STAGING

val STAGING: Deployment

TESTING

val TESTING: Deployment

Functions

getDeploymentFromEnvironmentVariable

fun getDeploymentFromEnvironmentVariable(defaultDeployment: Deployment = DEVELOPMENT, environmentVariableLoader: EnvironmentVariableLoader = EnvironmentVariableLoader.real): Deployment

Determines a Deployment based on the value within the ENVIRONMENT variable, defaulting to local development if not set (i.e. isLocalDevelopment == true)