Class: GraphQL::Types::Relay::BaseEdge

Inherits:

Schema::Object

• Object
• Schema::Member
• Schema::Object
• GraphQL::Types::Relay::BaseEdge

Includes:

EdgeBehaviors

Defined in:

lib/graphql/types/relay/base_edge.rb

Overview

A class-based definition for Relay edges.

Use this as a parent class in your app, or use it as inspiration for your own base Edge class.

For example, you may want to extend your own BaseObject instead of the built-in GraphQL::Schema::Object.

Examples:

Making a UserEdge type

# Make a base class for your app
class Types::BaseEdge < GraphQL::Types::Relay::BaseEdge
end

# Then extend your own base class
class Types::UserEdge < Types::BaseEdge
  node_type(Types::User)
end

See Also:

• for connection types

Constant Summary

Constants included from Schema::Member::HasFields

Schema::Member::HasFields::CONFLICT_FIELD_NAMES, Schema::Member::HasFields::GRAPHQL_RUBY_KEYWORDS, Schema::Member::HasFields::RUBY_KEYWORDS

Constants included from Schema::Member::HasDirectives

Schema::Member::HasDirectives::NO_DIRECTIVES

Constants included from Schema::Member::GraphQLTypeNames

Schema::Member::GraphQLTypeNames::Boolean, Schema::Member::GraphQLTypeNames::ID, Schema::Member::GraphQLTypeNames::Int

Instance Attribute Summary

Attributes inherited from Schema::Object

#context, #object

Method Summary

Methods inherited from Schema::Object

authorized_new, #dataloader, fields, inherited, #initialize, kind, #raw_value, to_graphql

Methods included from Schema::Member::HasFields

#add_field, #all_field_definitions, #field, #field_class, #fields, #get_field, #global_id_field, #own_fields

Methods included from Schema::Member::HasInterfaces

#implements, #interface_type_memberships, #interfaces, #own_interface_type_memberships

Methods included from Schema::Member::CachedGraphQLDefinition

#graphql_definition, #initialize_copy, #type_class

Methods included from Relay::TypeExtensions

#connection_type, #define_connection, #define_edge, #edge_type

Methods included from Schema::Member::BaseDSLMethods

#accessible?, #authorized?, #default_graphql_name, #description, #graphql_name, #introspection, #introspection?, #mutation, #name, #overridden_graphql_name, #to_graphql, #visible?

Methods included from Schema::Member::BaseDSLMethods::ConfigurationExtension

#inherited

Methods included from Schema::Member::TypeSystemHelpers

#kind, #list?, #non_null?, #to_list_type, #to_non_null_type, #to_type_signature

Methods included from Schema::Member::Scoped

#scope_items

Methods included from Schema::Member::RelayShortcuts

#connection_type, #connection_type_class, #edge_type, #edge_type_class

Methods included from Schema::Member::HasPath

#path

Methods included from Schema::Member::HasAstNode

#ast_node

Methods included from Schema::Member::HasDirectives

#directive, #directives, #remove_directive

Constructor Details

This class inherits a constructor from GraphQL::Schema::Object