struct Athena::Routing::Parameters

Overview

Encompasses parameters related to the Athena::Routing component.

For a higher level introduction to using parameters, see the external documentation.

Defined in:

parameters/parameters.cr

Constructors

Instance Method Summary

Constructor Detail

def self.configure : self #

This method should be overridden in order to customize the parameters for the Athena::Routing component. See the external documentation for more details.

# Returns an `ART::Parameters` instance with customized parameter values.
def ART::Parameters.configure
  new(
    base_uri: "https://myapp.com",
  )
end

[View source]
def self.new(base_uri : URI | String | Nil = nil) #

[View source]

Instance Method Detail

def base_uri : URI | Nil #

Returns an optional URI instance for use within ART::URLGeneratorInterface#generate.


[View source]