Class: GraphQL::ObjectType
- Defined in:
- lib/graphql/object_type.rb
Instance Attribute Summary collapse
-
#fields ⇒ Hash<String => GraphQL::Field>
Map String fieldnames to their Field implementations.
-
#mutation ⇒ GraphQL::Relay::Mutation?
The mutation this object type was derived from, if it is an auto-generated payload type.
-
#relay_node_type ⇒ Object
-
#structural_interface_type_memberships ⇒ Object
writeonly
Attributes inherited from BaseType
#ast_node, #default_relay, #default_scalar, #description, #introspection, #name
Instance Method Summary collapse
-
#all_fields ⇒ Array<GraphQL::Field>
These fields don’t have instrumenation applied.
-
#get_field(field_name) ⇒ GraphQL::Field
This fields doesnt have instrumenation applied.
-
#implements(interfaces, inherit: false, **options) ⇒ Object
Declare that this object implements this interface.
-
#initialize ⇒ ObjectType
constructor
A new instance of ObjectType.
-
#initialize_copy(other) ⇒ Object
-
#interfaces(ctx = GraphQL::Query::NullContext) ⇒ Object
-
#interfaces=(new_interfaces) ⇒ Object
deprecated
Deprecated.
Use
implements
instead ofinterfaces
. -
#kind ⇒ Object
-
#resolve_type_proc ⇒ Object
Methods inherited from BaseType
#==, #coerce_input, #coerce_isolated_input, #coerce_isolated_result, #coerce_result, #default_relay?, #default_scalar?, #introspection?, #list?, #non_null?, resolve_related_type, #resolve_type, #to_definition, #to_list_type, #to_non_null_type, #to_s, #type_class, #unwrap, #valid_input?, #valid_isolated_input?, #validate_input, #validate_isolated_input
Methods included from Relay::TypeExtensions
#connection_type, #define_connection, #define_edge, #edge_type
Methods included from Define::InstanceDefinable
Methods included from Define::NonNullWithBang
Constructor Details
#initialize ⇒ ObjectType
Returns a new instance of ObjectType.
17 18 19 20 21 22 23 |
# File 'lib/graphql/object_type.rb', line 17 def initialize super @fields = {} @clean_inherited_fields = nil @structural_interface_type_memberships = [] @inherited_interface_type_memberships = [] end |
Instance Attribute Details
#fields ⇒ Hash<String => GraphQL::Field>
Returns Map String fieldnames to their Field implementations.
11 12 13 |
# File 'lib/graphql/object_type.rb', line 11 def fields @fields end |
#mutation ⇒ GraphQL::Relay::Mutation?
Returns The mutation this object type was derived from, if it is an auto-generated payload type.
17 18 19 |
# File 'lib/graphql/object_type.rb', line 17 def mutation @mutation end |
#relay_node_type ⇒ Object
8 9 10 |
# File 'lib/graphql/object_type.rb', line 8 def relay_node_type @relay_node_type end |
#structural_interface_type_memberships=(value) ⇒ Object
100 101 102 |
# File 'lib/graphql/object_type.rb', line 100 def structural_interface_type_memberships=(value) @structural_interface_type_memberships = value end |
Instance Method Details
#all_fields ⇒ Array<GraphQL::Field>
These fields don’t have instrumenation applied
73 74 75 |
# File 'lib/graphql/object_type.rb', line 73 def all_fields interface_fields.merge(self.fields).values end |
#get_field(field_name) ⇒ GraphQL::Field
This fields doesnt have instrumenation applied
66 67 68 |
# File 'lib/graphql/object_type.rb', line 66 def get_field(field_name) fields[field_name] || interface_fields[field_name] end |
#implements(interfaces, inherit: false, **options) ⇒ Object
Declare that this object implements this interface. This declaration will be validated when the schema is defined.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/graphql/object_type.rb', line 81 def implements(interfaces, inherit: false, **) if !interfaces.is_a?(Array) raise ArgumentError, "`implements(interfaces)` must be an array, not #{interfaces.class} (#{interfaces})" end @clean_inherited_fields = nil type_memberships = inherit ? @inherited_interface_type_memberships : @structural_interface_type_memberships interfaces.each do |iface| iface = BaseType.(iface) if iface.is_a?(GraphQL::InterfaceType) type_memberships << iface.type_membership_class.new(iface, self, **) end end end |
#initialize_copy(other) ⇒ Object
25 26 27 28 29 30 |
# File 'lib/graphql/object_type.rb', line 25 def initialize_copy(other) super @structural_interface_type_memberships = other.structural_interface_type_memberships.dup @inherited_interface_type_memberships = other.inherited_interface_type_memberships.dup @fields = other.fields.dup end |
#interfaces(ctx = GraphQL::Query::NullContext) ⇒ Object
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'lib/graphql/object_type.rb', line 42 def interfaces(ctx = GraphQL::Query::NullContext) ensure_defined visible_ifaces = [] unfiltered = ctx == GraphQL::Query::NullContext [@structural_interface_type_memberships, @inherited_interface_type_memberships].each do |tms| tms.each do |type_membership| if unfiltered || type_membership.visible?(ctx) # if this is derived from a class-based object, we have to # get the `.graphql_definition` of the attached interface. visible_ifaces << GraphQL::BaseType.(type_membership.abstract_type) end end end visible_ifaces end |
#interfaces=(new_interfaces) ⇒ Object
Use implements
instead of interfaces
.
This method declares interfaces for this type AND inherits any field definitions
35 36 37 38 39 40 |
# File 'lib/graphql/object_type.rb', line 35 def interfaces=(new_interfaces) @structural_interface_type_memberships = [] @inherited_interface_type_memberships = [] @clean_inherited_fields = nil implements(new_interfaces, inherit: true) end |
#kind ⇒ Object
59 60 61 |
# File 'lib/graphql/object_type.rb', line 59 def kind GraphQL::TypeKinds::OBJECT end |
#resolve_type_proc ⇒ Object
96 97 98 |
# File 'lib/graphql/object_type.rb', line 96 def resolve_type_proc nil end |