module Crystal::Environment

Overview

require "crystal-environment"

Crystal.env.name         # => "development"
Crystal.env.development? # => true
Crystal.env.production?  # => false

Extended Modules

• Crystal::Environment

Defined in:

Constant Summary

DEFAULT = "development"

Default value used when ENV["CRYSTAL_ENV"]? is nil.

KEY = "CRYSTAL_ENV"

Environment variable name used to set the current environment #name.

VALUES = Set {"development", "test", "production"}

Default Set of environments.

VERSION = "0.1.0"

Macro Summary

• setup(keys)

  Appends given keys to the list of known environments.

Instance Method Summary

• #development?

  Returns true if #name equals "development", false otherwise.

• #name : String

  Returns value of ENV["CRYSTAL_ENV"]? if any, "development" otherwise.

• #name=(name : String | Symbol | Nil) : String | Nil

  Sets ENV["CRYSTAL_ENV"]? to the given name or unsets it, when passed nil.

• #production?

  Returns true if #name equals "production", false otherwise.

• #test?

  Returns true if #name equals "test", false otherwise.

Macro Detail

Crystal::Environment.setup %w(foo bar)

typeof(Crystal.env.foo?) # => Bool
typeof(Crystal.env.bar?) # => Bool

Instance Method Detail