Class: GraphQL::Relay::Mutation
- Inherits:
-
Object
- Object
- GraphQL::Relay::Mutation
- Includes:
- Define::InstanceDefinable
- Defined in:
- lib/graphql/relay/mutation.rb
Overview
Define a Relay mutation:
- give it a name (used for derived inputs & outputs)
- declare its inputs
- declare its outputs
- declare the mutation procedure
resolve
should return a hash with a key for each of the return_field
s
Inputs may also contain a clientMutationId
Defined Under Namespace
Classes: MutationResolve, Result
Instance Attribute Summary collapse
-
#arguments ⇒ Object
(also: #input_fields)
Returns the value of attribute arguments.
-
#description ⇒ Object
Returns the value of attribute description.
-
#fields ⇒ Object
(also: #return_fields)
Returns the value of attribute fields.
-
#name ⇒ Object
Returns the value of attribute name.
-
#return_interfaces ⇒ Object
Returns the value of attribute return_interfaces.
-
#return_type ⇒ Object
Returns the value of attribute return_type.
Instance Method Summary collapse
- #field ⇒ Object
- #has_generated_return_type? ⇒ Boolean
-
#initialize ⇒ Mutation
constructor
A new instance of Mutation.
- #input_type ⇒ Object
- #resolve=(new_resolve_proc) ⇒ Object
- #result_class ⇒ Object
Methods included from Define::InstanceDefinable
#define, #initialize_copy, #metadata, #redefine
Constructor Details
#initialize ⇒ Mutation
Returns a new instance of Mutation.
112 113 114 115 116 |
# File 'lib/graphql/relay/mutation.rb', line 112 def initialize @fields = {} @arguments = {} @has_generated_return_type = false end |
Instance Attribute Details
#arguments ⇒ Object Also known as: input_fields
Returns the value of attribute arguments.
100 101 102 |
# File 'lib/graphql/relay/mutation.rb', line 100 def arguments @arguments end |
#description ⇒ Object
Returns the value of attribute description.
100 101 102 |
# File 'lib/graphql/relay/mutation.rb', line 100 def description @description end |
#fields ⇒ Object Also known as: return_fields
Returns the value of attribute fields.
100 101 102 |
# File 'lib/graphql/relay/mutation.rb', line 100 def fields @fields end |
#name ⇒ Object
Returns the value of attribute name.
100 101 102 |
# File 'lib/graphql/relay/mutation.rb', line 100 def name @name end |
#return_interfaces ⇒ Object
Returns the value of attribute return_interfaces.
100 101 102 |
# File 'lib/graphql/relay/mutation.rb', line 100 def return_interfaces @return_interfaces end |
#return_type ⇒ Object
Returns the value of attribute return_type.
100 101 102 |
# File 'lib/graphql/relay/mutation.rb', line 100 def return_type @return_type end |
Instance Method Details
#field ⇒ Object
128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/graphql/relay/mutation.rb', line 128 def field @field ||= begin relay_mutation = self field_resolve_proc = @resolve_proc GraphQL::Field.define do type(relay_mutation.return_type) description(relay_mutation.description) argument :input, !relay_mutation.input_type resolve(field_resolve_proc) mutation(relay_mutation) end end end |
#has_generated_return_type? ⇒ Boolean
118 119 120 121 122 |
# File 'lib/graphql/relay/mutation.rb', line 118 def has_generated_return_type? # Trigger the generation of the return type, if it is dynamically generated: return_type @has_generated_return_type end |
#input_type ⇒ Object
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/graphql/relay/mutation.rb', line 163 def input_type @input_type ||= begin relay_mutation = self GraphQL::InputObjectType.define do name("#{relay_mutation.name}Input") description("Autogenerated input type of #{relay_mutation.name}") input_field :clientMutationId, types.String, "A unique identifier for the client performing the mutation." relay_mutation.arguments.each do |input_field_name, field_obj| kwargs = {} if field_obj.default_value? kwargs[:default_value] = field_obj.default_value end input_field(input_field_name, field_obj.type, field_obj.description, **kwargs) end mutation(relay_mutation) end end end |
#resolve=(new_resolve_proc) ⇒ Object
124 125 126 |
# File 'lib/graphql/relay/mutation.rb', line 124 def resolve=(new_resolve_proc) @resolve_proc = MutationResolve.new(self, new_resolve_proc, wrap_result: has_generated_return_type?) end |
#result_class ⇒ Object
182 183 184 185 186 |
# File 'lib/graphql/relay/mutation.rb', line 182 def result_class @result_class ||= begin Result.define_subclass(self) end end |