Skip to content

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

Base implementation of ATH::Params::ParamInterface.

Direct known subclasses

Athena::Framework::Params::ScalarParam

Constructors#

.new(name : String, has_default : Bool = false, incompatibles : Array(String)? = nil, strict : Bool = true, nilable : Bool = false, key : String? = nil, description : String? = nil)#

View source

Methods#

#constraints : Array(AVD::Constraint)#

:inherit:

View source

#description : String | ::Nil#

:inherit:

View source

#has_default? : Bool#

If this argument has a default value.

View source

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

:inherit:

View source

#key : String#

Returns the key that should be used to access self from a given request.

Defaults to #name, but may be customized. See the "Key" section of ATHA::QueryParam.

View source

#name : String#

:inherit:

View source

#nilable? : Bool#

If nil is a valid value for the param.

View source

#strict? : Bool#

:inherit:

View source