Class: GraphQL::EnumType
- Inherits:
-
Object
- Object
- GraphQL::EnumType
- Defined in:
- lib/graphql/enum_type.rb
Overview
A finite set of possible values, represented in query strings with SCREAMING_CASE_NAMES
Defined Under Namespace
Classes: EnumValue
Instance Attribute Summary collapse
-
#description ⇒ Object
Returns the value of attribute description.
-
#name ⇒ Object
Returns the value of attribute name.
-
#values ⇒ Object
Returns the value of attribute values.
Instance Method Summary collapse
-
#coerce(value_name) ⇒ Object
Get the underlying value for this enum value.
- #kind ⇒ Object
- #to_s ⇒ Object
-
#value(name, description = nil, deprecation_reason: nil, value: name) ⇒ Object
deprecated
Deprecated.
use define API instead
Methods included from DefinitionHelpers::DefinedByConfig
Methods included from DefinitionHelpers::NonNullWithBang
Instance Attribute Details
#description ⇒ Object
Returns the value of attribute description.
16 17 18 |
# File 'lib/graphql/enum_type.rb', line 16 def description @description end |
#name ⇒ Object
Returns the value of attribute name.
16 17 18 |
# File 'lib/graphql/enum_type.rb', line 16 def name @name end |
#values ⇒ Object
Returns the value of attribute values.
16 17 18 |
# File 'lib/graphql/enum_type.rb', line 16 def values @values end |
Instance Method Details
#coerce(value_name) ⇒ Object
Get the underlying value for this enum value
45 46 47 |
# File 'lib/graphql/enum_type.rb', line 45 def coerce(value_name) values[value_name].value end |
#kind ⇒ Object
33 34 35 |
# File 'lib/graphql/enum_type.rb', line 33 def kind GraphQL::TypeKinds::ENUM end |
#to_s ⇒ Object
49 50 51 |
# File 'lib/graphql/enum_type.rb', line 49 def to_s name end |
#value(name, description = nil, deprecation_reason: nil, value: name) ⇒ Object
Deprecated.
use define API instead
Define a value within this enum
29 30 31 |
# File 'lib/graphql/enum_type.rb', line 29 def value(name, description=nil, deprecation_reason: nil, value: name) values[name] = EnumValue.new(name: name, description: description, deprecation_reason: deprecation_reason, value: value) end |