API Reference¶

Complete API documentation for MywayConfig.

Core Classes¶

The main module provides setup and error classes.

Registers the XDG and defaults loaders with Anyway Config. Called automatically when the gem is loaded.

MywayConfig.setup!

Check if setup has been completed.

MywayConfig.setup?  # => true

Reset setup state (mainly for testing).

MywayConfig.reset!

Base error class for all MywayConfig errors.

begin
  # ...
rescue MywayConfig::Error => e
  # Handle any MywayConfig error
end

Raised for configuration problems:

begin
  MyConfig.new("/nonexistent/file.yml")
rescue MywayConfig::ConfigurationError => e
  puts "Config error: #{e.message}"
end

Reserved for validation errors (future use).

The gem version string.

MywayConfig::VERSION  # => "0.1.0"