Skip to content

abstract struct Athena::Framework::Params::ScalarParam
inherits Athena::Framework::Params::Param #

Extension of ATH::Params::Param that allows for more granular validation of scalar parameters.

Direct known subclasses

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

Constructors#

.new(name : String, has_default : Bool = false, incompatibles : Array(String)? = nil, requirements : AVD::Constraint | Array(AVD::Constraint) | Regex | Nil = nil, map : Bool = false, strict : Bool = true, nilable : Bool = false, key : String? = nil, description : String? = nil) #

View source

Methods#

#constraints #

:inherit:

View source

#map? #

Denotes whether the #requirements should be applied to the whole value, or to each item a part of the value.

See the "Map" section of ATHA::QueryParam.

View source

#requirements #

Returns the requirements that the value is required to pass in order to be considered valid.

See the "Requirements" section of ATHA::QueryParam.

View source