abstract struct Athena::Routing::Params::Param
- Athena::Routing::Params::Param
- Struct
- Value
- Object
Overview
Base implementation of ART::Params::ParamInterface
.
Direct Known Subclasses
Defined in:
params/param.crConstructors
Instance Method Summary
-
#constraints : Array(AVD::Constraint)
:inherit:
-
#description : String | Nil
:inherit:
-
#has_default? : Bool
If this argument has a default value.
-
#incompatibles : Array(String) | Nil
:inherit:
-
#key : String
Returns the key that should be used to access
self
from a given request. -
#name : String
:inherit:
-
#nilable? : Bool
If
nil
is a valid value for the param. -
#strict? : Bool
:inherit:
Constructor Detail
def self.new(name : String, has_default : Bool = false, incompatibles : Array(String) | Nil = nil, strict : Bool = true, nilable : Bool = false, key : String | Nil = nil, description : String | Nil = nil)
#
Instance Method Detail
def 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 ARTA::QueryParam
.