Environment

Topics

Structures

• struct Process
  The process information of an environment. Wraps ProcessInto.processInfo.

Operators

• static func == (Environment, Environment) -> Bool
  See Equatable

Initializers

• init(name: String, arguments: [String])
  Create a new Environment.

Instance Properties

• var arguments: [String]
  The command-line arguments for this Environment.
• var commandInput: CommandInput
  Exposes the Environment’s arguments property as a CommandInput.
• var isRelease: Bool
  true if this environment is meant for production use cases.
• let name: String
  The environment’s unique name.

Type Properties

• static var development: Environment
  An environment for developing your application.
• static var process: Environment.Process
  The current process of the environment.
• static var production: Environment
  An environment for deploying your application to consumers.
• static var testing: Environment
  An environment for testing your application.

Type Methods

• static func custom(name: String) -> Environment
  Creates a custom environment.
• static func detect(arguments: [String]) throws -> Environment
  Detects the environment from CommandLine.arguments. Invokes detect(from:).
• static func detect(from: inout CommandInput) throws -> Environment
  Detects the environment from CommandInput. Parses the --env flag, with the VAPOR_ENV environment variable as a fallback.
• static func get(String) -> String?
  Gets a key from the process environment
• static func secret(key: String) async throws -> String?
  Reads a file’s content for a secret. The secret key is the name of the environment variable that is expected to specify the path of the file containing the secret.
• static func secret(key: String, fileIO: NonBlockingFileIO, on: any EventLoop) -> EventLoopFuture<String?>
  Reads a file’s content for a secret. The secret key is the name of the environment variable that is expected to specify the path of the file containing the secret.
• static func secret(path: String) async throws -> String?
  Load the content of a file at a given path as a secret.
• static func secret(path: String, fileIO: NonBlockingFileIO, on: any EventLoop) -> EventLoopFuture<String?>
  Load the content of a file at a given path as a secret.