Class: GraphQL::BaseType

Inherits:
Object
  • Object
show all
Includes:
Define::InstanceDefinable, Define::NonNullWithBang
Defined in:
lib/graphql/base_type.rb

Overview

The parent for all type classes.

Defined Under Namespace

Modules: ModifiesAnotherType

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Define::InstanceDefinable

#define, #definition_proc=, #metadata

Methods included from Define::NonNullWithBang

#!

Instance Attribute Details

#descriptionString?

Returns a description for this type

Returns:

  • (String, nil)

    a description for this type


# File 'lib/graphql/base_type.rb', line 16

#nameString

Returns the name of this type, must be unique within a Schema

Returns:

  • (String)

    the name of this type, must be unique within a Schema


# File 'lib/graphql/base_type.rb', line 13

Class Method Details

During schema definition, types can be defined inside procs or as strings. This function converts it to a type instance

Returns:


88
89
90
91
92
93
94
95
96
97
98
99
# File 'lib/graphql/base_type.rb', line 88

def self.resolve_related_type(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)

Parameters:

Returns:

  • (Boolean)

    are these types equivalent? (incl. non-null, list)


21
22
23
24
25
26
27
# File 'lib/graphql/base_type.rb', line 21

def ==(other)
  if other.is_a?(GraphQL::BaseType)
    self.to_s == other.to_s
  else
    super
  end
end

#coerce_input(value) ⇒ Object


73
74
75
76
# File 'lib/graphql/base_type.rb', line 73

def coerce_input(value)
  return nil if value.nil?
  coerce_non_null_input(value)
end

#connection_typeObject

Get the default connection type for this object type


102
103
104
# File 'lib/graphql/base_type.rb', line 102

def connection_type
  @connection_type ||= define_connection
end

#define_connection(**kwargs, &block) ⇒ Object

Define a custom connection type for this object type


107
108
109
# File 'lib/graphql/base_type.rb', line 107

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


117
118
119
# File 'lib/graphql/base_type.rb', line 117

def define_edge(**kwargs, &block)
  GraphQL::Relay::EdgeType.create_type(self, **kwargs, &block)
end

#edge_typeObject

Get the default edge type for this object type


112
113
114
# File 'lib/graphql/base_type.rb', line 112

def edge_type
  @edge_type ||= define_edge
end

#get_field(name) ⇒ GraphQL::Field?

Types with fields may override this

Parameters:

  • name (String)

    field name to lookup for this type

Returns:


81
82
83
# File 'lib/graphql/base_type.rb', line 81

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)


53
54
55
# File 'lib/graphql/base_type.rb', line 53

def resolve_type(value)
  self
end

#to_list_typeGraphQL::ListType

Returns a list version of this type

Returns:


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

def to_list_type
  GraphQL::ListType.new(of_type: self)
end

#to_non_null_typeGraphQL::NonNullType

Returns a non-null version of this type

Returns:


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

def to_non_null_type
  GraphQL::NonNullType.new(of_type: self)
end

#to_sObject Also known as: inspect

Print the human-readable name of this type using the query-string naming pattern


58
59
60
# File 'lib/graphql/base_type.rb', line 58

def to_s
  name
end

#unwrapObject

If this type is modifying an underlying type, return the underlying type. (Otherwise, return self.)


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

def unwrap
  self
end

#valid_input?(value) ⇒ Boolean

Returns:

  • (Boolean)

64
65
66
# File 'lib/graphql/base_type.rb', line 64

def valid_input?(value)
  validate_input(value).valid?
end

#validate_input(value) ⇒ Object


68
69
70
71
# File 'lib/graphql/base_type.rb', line 68

def validate_input(value)
  return GraphQL::Query::InputValidationResult.new if value.nil?
  validate_non_null_input(value)
end