module Athena::Routing::Params::ParamInterface
Overview
Represents a request parameter; e.x. query param, form data, a file, etc.
See ARTA::QueryParam and ARTA::RequestParam.
Direct including types
Defined in:
params/param_interface.crInstance Method Summary
-
#constraints : Array(AVD::Constraint)
Returns the
AVD::Constraints that should be used to validate the parameter's value. -
#default
Returns the value that should be used if
#strict?is false and the parameter was not provided, defaulting tonil. -
#description : String | Nil
Returns a human readable summary of what the parameter is used for.
-
#extract_value(request : HTTP::Request, default : _ = nil)
Returns the
self's value from the provided request, or default if it was not present. -
#incompatibles : Array(String) | Nil
Returns the parameters that may not be present at the same time as
self. -
#name : String
Returns the name of the parameter, maps to the controller action argument name.
-
#strict? : Bool
Denotes whether
selfshould be processed strictly.
Instance Method Detail
Returns the AVD::Constraints that should be used to validate the parameter's value.
Returns the value that should be used if #strict? is false and the parameter was not provided, defaulting to 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.
Returns the self's value from the provided request, or default if it was not present.
Returns the parameters that may not be present at the same time as self. See the "Incompatibilities" section of ARTA::QueryParam.
Returns the name of the parameter, maps to the controller action argument name.
Denotes whether self should be processed strictly. See the "Strict" section of ARTA::QueryParam.