Class: GraphQL::Schema::Enum

Inherits:
Member
  • Object
show all
Extended by:
Forwardable, Member::AcceptsDefinition
Defined in:
lib/graphql/schema/enum.rb

Constant Summary

Constants included from Member::GraphQLTypeNames

Member::GraphQLTypeNames::Boolean, Member::GraphQLTypeNames::ID, Member::GraphQLTypeNames::Int

Class Method Summary collapse

Methods included from Member::HasPath

#path

Methods included from Member::RelayShortcuts

#connection_type, #connection_type_class, #edge_type, #edge_type_class

Methods included from Member::Scoped

#scope_items

Methods included from Member::TypeSystemHelpers

#kind, #list?, #non_null?, #to_list_type, #to_non_null_type, #to_type_signature

Methods included from Member::BaseDSLMethods

#accessible?, #authorized?, #default_graphql_name, #description, #graphql_name, #introspection, #introspection?, #mutation, #name, #overridden_graphql_name, #to_graphql, #visible?

Methods included from Relay::TypeExtensions

#connection_type, #define_connection, #define_edge, #edge_type

Methods included from Member::CachedGraphQLDefinition

#graphql_definition, #initialize_copy

Class Method Details

.enum_value_class(new_enum_value_class = nil) ⇒ Class

Returns for handling value(...) inputs and building GraphQL::Enum::EnumValues out of them

Returns:

  • (Class) —

    for handling value(...) inputs and building GraphQL::Enum::EnumValues out of them



64
65
66
67
68
69
 
# File 'lib/graphql/schema/enum.rb', line 64

def enum_value_class(new_enum_value_class = nil)
  if new_enum_value_class
    @enum_value_class = new_enum_value_class
  end
  @enum_value_class || (superclass <= GraphQL::Schema::Enum ? superclass.enum_value_class : nil)
end

.kind ⇒ Object 



71
72
73
 
# File 'lib/graphql/schema/enum.rb', line 71

def kind
  GraphQL::TypeKinds::ENUM
end

.to_graphql ⇒ GraphQL::EnumType

Returns:



51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/graphql/schema/enum.rb', line 51

def to_graphql
  enum_type = GraphQL::EnumType.new
  enum_type.name = graphql_name
  enum_type.description = description
  enum_type.introspection = introspection
  values.each do |name, val|
    enum_type.add_value(val.to_graphql)
  end
  enum_type.metadata[:type_class] = self
  enum_type
end

.value(*args, **kwargs, &block) ⇒ void

This method returns an undefined value.

Define a value for this enum

Parameters:

  • graphql_name (String, Symbol) —

    the GraphQL value for this, usually SCREAMING_CASE

  • description (String) —

    , the GraphQL description for this value, present in documentation

  • value (Object) —

    , the translated Ruby value for this object (defaults to graphql_name)

  • deprecation_reason (String) —

    if this object is deprecated, include a message here

See Also:

  • which handles these inputs by default


36
37
38
39
40
41
 
# File 'lib/graphql/schema/enum.rb', line 36

def value(*args, **kwargs, &block)
  kwargs[:owner] = self
  value = enum_value_class.new(*args, **kwargs, &block)
  own_values[value.graphql_name] = value
  nil
end

.values ⇒ Hash<String => GraphQL::Schema::Enum::Value>

Returns Possible values of this enum, keyed by name

Returns:

  • (Hash<String => GraphQL::Schema::Enum::Value>) —

    Possible values of this enum, keyed by name



44
45
46
47
48
 
# File 'lib/graphql/schema/enum.rb', line 44

def values
  inherited_values = superclass <= GraphQL::Schema::Enum ? superclass.values : {}
  # Local values take precedence over inherited ones
  inherited_values.merge(own_values)
end