Class: GraphQL::ObjectType

Inherits:
BaseType show all
Defined in:
lib/graphql/object_type.rb

Overview

This type exposes fields on an object.

Examples:

defining a type for your IMDB clone

MovieType = GraphQL::ObjectType.define do
  name "Movie"
  description "A full-length film or a short film"
  interfaces [ProductionInterface, DurationInterface]

  field :runtimeMinutes, !types.Int, property: :runtime_minutes
  field :director, PersonType
  field :cast, CastType
  field :starring, types[PersonType] do
    arguments :limit, types.Int
    resolve -> (object, args, ctx) {
      stars = object.cast.stars
      args[:limit] && stars = stars.limit(args[:limit])
      stars
    }
   end
end

Defined Under Namespace

Classes: UnresolvedTypeError

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from BaseType

#==, #coerce_input, resolve_related_type, #resolve_type, #to_list_type, #to_non_null_type, #to_s, #unwrap, #valid_input?, #validate_input

Methods included from Define::InstanceDefinable

included

Methods included from Define::NonNullWithBang

#!

Constructor Details

#initialize ⇒ ObjectType

Returns a new instance of ObjectType.



30
31
32
33
 
# File 'lib/graphql/object_type.rb', line 30

def initialize
  @fields = {}
  @dirty_interfaces = []
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



25
26
27
 
# File 'lib/graphql/object_type.rb', line 25

def description
  @description
end

#fields ⇒ Hash<String => GraphQL::Field>

Returns Map String fieldnames to their Field implementations.

Returns:



28
29
30
 
# File 'lib/graphql/object_type.rb', line 28

def fields
  @fields
end

#name ⇒ Object

Returns the value of attribute name.



25
26
27
 
# File 'lib/graphql/object_type.rb', line 25

def name
  @name
end

Instance Method Details

#all_fields ⇒ Array<GraphQL::Field>

Returns All fields, including ones inherited from interfaces.

Returns:

  • (Array<GraphQL::Field>) —

    All fields, including ones inherited from interfaces



59
60
61
 
# File 'lib/graphql/object_type.rb', line 59

def all_fields
  interface_fields.merge(self.fields).values
end

#get_field(field_name) ⇒ GraphQL::Field

Returns The field definition for ‘field_name` (may be inherited from interfaces).

Returns:

  • (GraphQL::Field) —

    The field definition for ‘field_name` (may be inherited from interfaces)



54
55
56
 
# File 'lib/graphql/object_type.rb', line 54

def get_field(field_name)
  fields[field_name] || interface_fields[field_name]
end

#interfaces ⇒ Object 



41
42
43
44
45
46
47
 
# File 'lib/graphql/object_type.rb', line 41

def interfaces
  @clean_interfaces ||= begin
    @dirty_interfaces.map { |i_type| GraphQL::BaseType.resolve_related_type(i_type) }
  rescue
    @dirty_interfaces
  end
end

#interfaces=(new_interfaces) ⇒ Object

Parameters:

  • new_interfaces (Array<GraphQL::Interface>) —

    interfaces that this type implements



36
37
38
39
 
# File 'lib/graphql/object_type.rb', line 36

def interfaces=(new_interfaces)
  @clean_interfaces = nil
  @dirty_interfaces = new_interfaces
end

#kind ⇒ Object 



49
50
51
 
# File 'lib/graphql/object_type.rb', line 49

def kind
  GraphQL::TypeKinds::OBJECT
end