Class: GraphQL::InputObjectType

Inherits:
BaseType
  • Object
show all
Defined in:
lib/graphql/input_object_type.rb

Overview

InputObjectTypes are key-value inputs for fields.

Input objects have arguments which are identical to Field arguments. They map names to types and support default values. Their input types can be any input types, including InputObjectTypes.

In a ‘resolve` function, you can access the values by making nested lookups on `args`.

Examples:

An input type with name and number

PlayerInput = GraphQL::InputObjectType.define do
  name("Player")
  argument :name, !types.String
  argument :number, !types.Int
end

Accessing input values in a resolve function

resolve -> (obj, args, ctx) {
  args[:player][:name]    # => "Tony Gwynn"
  args[:player][:number]  # => 19
  args[:player].to_h      # { "name" => "Tony Gwynn", "number" => 19 }
  # ...
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from BaseType

#==, #coerce_input, #connection_type, #define_connection, #define_edge, #edge_type, #get_field, resolve_related_type, #resolve_type, #to_list_type, #to_non_null_type, #to_s, #unwrap, #valid_input?, #validate_input

Methods included from Define::InstanceDefinable

#definition_proc=, included, #metadata

Methods included from Define::NonNullWithBang

#!

Constructor Details

#initialize ⇒ InputObjectType

Returns a new instance of InputObjectType.



41
42
43
 
# File 'lib/graphql/input_object_type.rb', line 41

def initialize
  @arguments = {}
end

Instance Attribute Details

#arguments ⇒ Hash<String => GraphQL::Argument> Also known as: input_fields

Returns Map String argument names to their Argument implementations.

Returns:



33
34
35
36
 
# File 'lib/graphql/input_object_type.rb', line 33

def arguments
  ensure_defined
  @arguments
end

Instance Method Details

#coerce_non_null_input(value) ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/graphql/input_object_type.rb', line 70

def coerce_non_null_input(value)
  input_values = {}

  arguments.each do |input_key, input_field_defn|
    field_value = value[input_key]
    field_value = input_field_defn.type.coerce_input(field_value)

    # Try getting the default value
    if field_value.nil?
      field_value = input_field_defn.default_value
    end

    if !field_value.nil?
      input_values[input_key] = field_value
    end
  end

  GraphQL::Query::Arguments.new(input_values)
end

#kind ⇒ Object 



45
46
47
 
# File 'lib/graphql/input_object_type.rb', line 45

def kind
  GraphQL::TypeKinds::INPUT_OBJECT
end

#validate_non_null_input(input) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/graphql/input_object_type.rb', line 49

def validate_non_null_input(input)
  result = GraphQL::Query::InputValidationResult.new

  # Items in the input that are unexpected
  input.each do |name, value|
    if arguments[name].nil?
      result.add_problem("Field is not defined on #{self.name}", [name])
    end
  end

  # Items in the input that are expected, but have invalid values
  invalid_fields = arguments.map do |name, field|
    field_result = field.type.validate_input(input[name])
    if !field_result.valid?
      result.merge_result!(name, field_result)
    end
  end

  result
end