Skip to content

module Athena::Framework::Params::ParamInterface #

Represents a request parameter; e.x. query param, form data, a file, etc.

See ATHA::QueryParam and ATHA::RequestParam.

Direct including types

Athena::Framework::Params::QueryParam(T) Athena::Framework::Params::RequestParam(T)

Methods#

abstract #constraints : Array(AVD::Constraint)#

Returns the AVD::Constraints that should be used to validate the parameter's value.

View source

abstract #default#

Returns the value that should be used if #strict? is false and the parameter was not provided, defaulting to nil.

View source

abstract #description : String | ::Nil#

Returns a human readable summary of what the parameter is used for. In the future this may be used to supplement auto generated endpoint documentation.

View source

abstract #extract_value(request : ATH::Request, default : _ = nil)#

Returns the self's value from the provided request, or default if it was not present.

View source

abstract #incompatibles : Array(String) | ::Nil#

Returns the parameters that may not be present at the same time as self. See the "Incompatibilities" section of ATHA::QueryParam.

View source

abstract #name : String#

Returns the name of the parameter, maps to the controller action argument name.

View source

abstract #strict? : Bool#

Denotes whether self should be processed strictly. See the "Strict" section of ATHA::QueryParam.

View source