class GraphQL::Schema::EnumValue

A possible value for an Enum.

You can extend this class to customize enum values in your schema.

Examples

Example: custom enum value class

# define a custom class:
class CustomEnumValue < GraphQL::Schema::EnumValue
  def initialize(*args)
    # arguments to `value(...)` in Enum classes are passed here
    super
  end
end

class BaseEnum < GraphQL::Schema::Enum
  # use it for these enums:
  enum_value_class CustomEnumValue
end

Attributes

graphql_name [R]

owner [R]

Returns

Class — The enum type that owns this value

Public Class Methods

new (graphql_name, desc = nil, owner:, ast_node: nil, directives: nil, description: nil, comment: nil, value: NOT_CONFIGURED, deprecation_reason: nil, &block)

Source

# File lib/graphql/schema/enum_value.rb, line 41
def initialize(graphql_name, desc = nil, owner:, ast_node: nil, directives: nil, description: nil, comment: nil, value: NOT_CONFIGURED, deprecation_reason: nil, &block)
  @graphql_name = graphql_name.to_s
  GraphQL::NameValidator.validate!(@graphql_name)
  @description = desc || description
  @comment = comment
  @value = value == NOT_CONFIGURED ? @graphql_name : value
  if deprecation_reason
    self.deprecation_reason = deprecation_reason
  end
  @owner = owner
  @ast_node = ast_node
  if directives
    directives.each do |dir_class, dir_options|
      directive(dir_class, **dir_options)
    end
  end

  if block_given?
    instance_exec(self, &block)
  end
end

Public Instance Methods

authorized? (_ctx)

Source

# File lib/graphql/schema/enum_value.rb, line 89
def authorized?(_ctx); true; end

comment (new_comment = nil)

Source

# File lib/graphql/schema/enum_value.rb, line 70
def comment(new_comment = nil)
  if new_comment
    @comment = new_comment
  end
  @comment
end

description (new_desc = nil)

Source

# File lib/graphql/schema/enum_value.rb, line 63
def description(new_desc = nil)
  if new_desc
    @description = new_desc
  end
  @description
end

inspect ()

Source

# File lib/graphql/schema/enum_value.rb, line 84
def inspect
  "#<#{self.class} #{path} @value=#{@value.inspect}#{description ? " @description=#{description.inspect}" : ""}#{deprecation_reason ? " @deprecation_reason=#{deprecation_reason.inspect}" : ""}>"
end

value (new_val = nil)

Source

# File lib/graphql/schema/enum_value.rb, line 77
def value(new_val = nil)
  unless new_val.nil?
    @value = new_val
  end
  @value
end

visible? (_ctx)

Source

# File lib/graphql/schema/enum_value.rb, line 88
def visible?(_ctx); true; end