Class: GraphQL::UnionType

Inherits:
BaseType show all
Defined in:
lib/graphql/union_type.rb

Overview

A Union is is a collection of object types which may appear in the same place.

The members of a union are declared with possible_types.

A union itself has no fields; only its members have fields. So, when you query, you must use fragment spreads to access fields.

Examples:

A union of object types

MediaUnion = GraphQL::UnionType.define do
  name "Media"
  description "Media objects which you can enjoy"
  possible_types [AudioType, ImageType, VideoType]
end

Querying for fields on union members

{
  searchMedia(name: "Jens Lekman") {
    ... on Audio { name, duration }
    ... on Image { name, height, width }
    ... on Video { name, length, quality }
  }
}

Instance Attribute Summary

Attributes inherited from BaseType

#description, #name

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

#define, #metadata, #redefine

Methods included from Define::NonNullWithBang

#!

Instance Method Details

#include?(child_type_defn) ⇒ Boolean

Returns True if child_type_defn is a member of this GraphQL::UnionType.

Returns:



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

def include?(child_type_defn)
  possible_types.include?(child_type_defn)
end

#initialize_copy(other) ⇒ Object 



30
31
32
33
34
 
# File 'lib/graphql/union_type.rb', line 30

def initialize_copy(other)
  super
  @clean_possible_types = nil
  @dirty_possible_types = other.dirty_possible_types.dup
end

#kind ⇒ Object 



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

def kind
  GraphQL::TypeKinds::UNION
end

#possible_types ⇒ Array<GraphQL::ObjectType>

Returns Types which may be found in this union.

Returns:



51
52
53
54
55
56
57
58
59
 
# File 'lib/graphql/union_type.rb', line 51

def possible_types
  @clean_possible_types ||= begin
    if @dirty_possible_types.respond_to?(:map)
      @dirty_possible_types.map { |type| GraphQL::BaseType.resolve_related_type(type) }
    else
      @dirty_possible_types
    end
  end
end

#possible_types=(new_possible_types) ⇒ Object 



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

def possible_types=(new_possible_types)
  @clean_possible_types = nil
  @dirty_possible_types = new_possible_types
end