Class: GraphQL::BaseType
- Inherits:
-
Object
- Object
- GraphQL::BaseType
- Includes:
- Define::InstanceDefinable, Define::NonNullWithBang
- Defined in:
- lib/graphql/base_type.rb
Overview
The parent for all type classes.
Direct Known Subclasses
EnumType, InputObjectType, InterfaceType, ListType, NonNullType, ObjectType, ScalarType, UnionType
Defined Under Namespace
Modules: ModifiesAnotherType
Instance Attribute Summary collapse
-
#description ⇒ String?
A description for this type.
-
#name ⇒ String
The name of this type, must be unique within a Schema.
Class Method Summary collapse
-
.resolve_related_type(type_arg) ⇒ GraphQL::BaseType
During schema definition, types can be defined inside procs or as strings.
Instance Method Summary collapse
-
#==(other) ⇒ Boolean
Are these types equivalent? (incl. non-null, list).
- #coerce_input(value) ⇒ Object
-
#connection_type ⇒ Object
Get the default connection type for this object type.
-
#define_connection(**kwargs, &block) ⇒ Object
Define a custom connection type for this object type.
-
#define_edge(**kwargs, &block) ⇒ Object
Define a custom edge type for this object type.
-
#edge_type ⇒ Object
Get the default edge type for this object type.
-
#get_field(name) ⇒ GraphQL::Field?
Types with fields may override this.
-
#resolve_type(value) ⇒ Object
Find out which possible type to use for
value
. -
#to_list_type ⇒ GraphQL::ListType
A list version of this type.
-
#to_non_null_type ⇒ GraphQL::NonNullType
A non-null version of this type.
-
#to_s ⇒ Object
(also: #inspect)
Print the human-readable name of this type using the query-string naming pattern.
-
#unwrap ⇒ Object
If this type is modifying an underlying type, return the underlying type.
- #valid_input?(value, warden) ⇒ Boolean
- #validate_input(value, warden) ⇒ Object
Methods included from Define::InstanceDefinable
Methods included from Define::NonNullWithBang
Instance Attribute Details
#description ⇒ String?
Returns a description for this type.
17 18 19 |
# File 'lib/graphql/base_type.rb', line 17 def description @description end |
#name ⇒ String
Returns the name of this type, must be unique within a Schema.
14 15 16 |
# File 'lib/graphql/base_type.rb', line 14 def name @name end |
Class Method Details
.resolve_related_type(type_arg) ⇒ GraphQL::BaseType
During schema definition, types can be defined inside procs or as strings. This function converts it to a type instance
92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/graphql/base_type.rb', line 92 def self.(type_arg) case type_arg when Proc # lazy-eval it type_arg.call when String # Get a constant by this name Object.const_get(type_arg) else type_arg end end |
Instance Method Details
#==(other) ⇒ Boolean
Returns are these types equivalent? (incl. non-null, list).
22 23 24 25 26 27 28 |
# File 'lib/graphql/base_type.rb', line 22 def ==(other) if other.is_a?(GraphQL::BaseType) self.to_s == other.to_s else super end end |
#coerce_input(value) ⇒ Object
77 78 79 80 |
# File 'lib/graphql/base_type.rb', line 77 def coerce_input(value) return nil if value.nil? coerce_non_null_input(value) end |
#connection_type ⇒ Object
Get the default connection type for this object type
106 107 108 |
# File 'lib/graphql/base_type.rb', line 106 def connection_type @connection_type ||= define_connection end |
#define_connection(**kwargs, &block) ⇒ Object
Define a custom connection type for this object type
111 112 113 |
# File 'lib/graphql/base_type.rb', line 111 def define_connection(**kwargs, &block) GraphQL::Relay::ConnectionType.create_type(self, **kwargs, &block) end |
#define_edge(**kwargs, &block) ⇒ Object
Define a custom edge type for this object type
121 122 123 |
# File 'lib/graphql/base_type.rb', line 121 def define_edge(**kwargs, &block) GraphQL::Relay::EdgeType.create_type(self, **kwargs, &block) end |
#edge_type ⇒ Object
Get the default edge type for this object type
116 117 118 |
# File 'lib/graphql/base_type.rb', line 116 def edge_type @edge_type ||= define_edge end |
#get_field(name) ⇒ GraphQL::Field?
Types with fields may override this
85 86 87 |
# File 'lib/graphql/base_type.rb', line 85 def get_field(name) nil end |
#resolve_type(value) ⇒ Object
Find out which possible type to use for value
.
Returns self if there are no possible types (ie, not Union or Interface)
54 55 56 |
# File 'lib/graphql/base_type.rb', line 54 def resolve_type(value) self end |
#to_list_type ⇒ GraphQL::ListType
Returns a list version of this type.
42 43 44 |
# File 'lib/graphql/base_type.rb', line 42 def to_list_type GraphQL::ListType.new(of_type: self) end |
#to_non_null_type ⇒ GraphQL::NonNullType
Returns a non-null version of this type.
37 38 39 |
# File 'lib/graphql/base_type.rb', line 37 def to_non_null_type GraphQL::NonNullType.new(of_type: self) end |
#to_s ⇒ Object Also known as: inspect
Print the human-readable name of this type using the query-string naming pattern
59 60 61 |
# File 'lib/graphql/base_type.rb', line 59 def to_s name end |
#unwrap ⇒ Object
If this type is modifying an underlying type,
return the underlying type. (Otherwise, return self
.)
32 33 34 |
# File 'lib/graphql/base_type.rb', line 32 def unwrap self end |
#valid_input?(value, warden) ⇒ Boolean
65 66 67 |
# File 'lib/graphql/base_type.rb', line 65 def valid_input?(value, warden) validate_input(value, warden).valid? end |
#validate_input(value, warden) ⇒ Object
69 70 71 72 73 74 75 |
# File 'lib/graphql/base_type.rb', line 69 def validate_input(value, warden) if value.nil? GraphQL::Query::InputValidationResult.new else validate_non_null_input(value, warden) end end |